visionmedia/commander
The complete solution for Ruby command-line executables – Read the documentation
This page shows an evaluation of the documentation of visionmedia/commander.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
| Seems really good | ||
|---|---|---|
|
A
|
Commander::Runner#always_trace! |
|
|
A
|
Commander::Runner#never_trace! |
|
|
A
|
Commander::Runner#run! |
|
|
A
|
Commander::UI |
|
|
A
|
Commander::UI.io |
|
| Show 32 more ... | ||
|
A
|
Commander::Runner#valid_command_names_from |
|
|
A
|
Commander::Runner#help_formatter_alias_defaults |
|
|
A
|
Commander::Command::Options#initialize |
|
|
A
|
Commander::Runner#program_defaults |
|
|
A
|
Commander::Command::Options |
|
|
A
|
Commander::UI::ProgressBar |
|
|
A
|
Commander::HelpFormatter |
|
|
A
|
Commander::Runner#args_without_command_name |
|
|
A
|
Commander::UI::ProgressBar#percent_complete |
|
|
A
|
Commander::UI::ProgressBar#generate_tokens |
|
|
A
|
Commander::UI::ProgressBar#steps_remaining |
|
|
A
|
Commander::UI::ProgressBar#time_remaining |
|
|
A
|
Commander::Runner#create_default_commands |
|
|
A
|
Commander::Runner#command_name_from_args |
|
|
A
|
Commander::Runner#help_formatter_aliases |
|
|
A
|
Commander::UI::ProgressBar#progress_bar |
|
|
A
|
Commander::UI::ProgressBar#time_elapsed |
|
|
A
|
Commander::Command#proxy_option_struct |
|
|
A
|
Commander::Runner#parse_global_options |
|
|
A
|
Commander::UI::ProgressBar#erase_line |
|
|
A
|
Commander::Runner#run_active_command |
|
|
A
|
Commander::Runner#help_formatter |
|
|
A
|
Commander::Runner#active_command |
|
|
A
|
Commander::UI::ProgressBar#show |
|
|
A
|
Commander::UI.enable_paging |
|
|
A
|
Commander::Runner.instance |
|
|
A
|
Commander::Runner#commands |
|
|
A
|
Commander::Runner#version |
|
|
A
|
Commander::Runner#options |
|
|
A
|
Commander::UI.reset_io |
|
|
A
|
Object#get_binding |
|
|
A
|
Commander::Runner.switch_to_sym |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Commander::Command#when_called |
|
|
B
|
Commander::Runner#program |
|
|
B
|
Commander::Command#option |
|
|
B
|
Commander::Runner#global_option |
|
|
B
|
Commander::Runner#command |
|
| Show 31 more ... | ||
|
B
|
Commander::UI.progress |
|
|
B
|
Commander::UI.log |
|
|
B
|
Commander::Runner.separate_switches_from_description |
|
|
B
|
Commander::Command#parse_options_and_call_procs |
|
|
B
|
Commander::Runner#global_option_proc |
|
|
B
|
Commander::Runner#require_program |
|
|
B
|
Commander::Runner#alias_command |
|
|
B
|
Commander::UI.say_warning |
|
|
B
|
Commander::UI.say_error |
|
|
B
|
Commander::Command#run |
|
|
B
|
Commander::UI.choose |
|
|
B
|
Commander::UI.say_ok |
|
|
B
|
Commander::UI.color |
|
|
B
|
Commander::UI::ProgressBar#initialize |
|
|
B
|
Commander::UI.ask_editor |
|
|
B
|
Commander::UI.converse |
|
|
B
|
Commander::UI.speak |
|
|
B
|
Array.parse |
|
|
B
|
Commander::Command#example |
|
|
B
|
Commander::Runner#require_valid_command |
|
|
B
|
Commander::Runner#remove_global_options |
|
|
B
|
Commander::UI::ProgressBar#increment |
|
|
B
|
Commander::Runner#default_command |
|
|
B
|
Commander::UI.available_editor |
|
|
B
|
Commander::Command#option_proc |
|
|
B
|
Commander::Runner#add_command |
|
|
B
|
Commander::Command#initialize |
|
|
B
|
Commander::Runner#initialize |
|
|
B
|
Commander::UI.applescript |
|
|
B
|
Commander::Command#call |
|
|
B
|
Commander::UI.password |
|
| Needs work | ||
|---|---|---|
| – |
| Undocumented | ||
|---|---|---|
|
U
|
Commander |
|
|
U
|
Object |
|
|
U
|
Blank |
|
|
U
|
Array |
|
|
U
|
Commander::Command::Options#method_missing |
|
| Show 33 more ... | ||
|
U
|
Commander.configure |
|
|
U
|
Commander::Command |
|
|
U
|
Commander::Runner |
|
|
U
|
Commander::HelpFormatter::Base#render_command |
|
|
U
|
Commander::HelpFormatter::Terminal#template |
|
|
U
|
Commander::HelpFormatter::TerminalCompact |
|
|
U
|
Commander::HelpFormatter::Base#initialize |
|
|
U
|
Commander::HelpFormatter::Base#render |
|
|
U
|
Commander::Command::Options#__hash__ |
|
|
U
|
Commander::Command::Options#inspect |
|
|
U
|
Commander::Command::Options#default |
|
|
U
|
Commander::HelpFormatter::Terminal |
|
|
U
|
Commander::Command#proxy_options= |
|
|
U
|
Commander::Command#proxy_options |
|
|
U
|
Commander::Command#description= |
|
|
U
|
Commander::HelpFormatter.indent |
|
|
U
|
Commander::Command#description |
|
|
U
|
Commander::HelpFormatter::Base |
|
|
U
|
Commander::Command#examples= |
|
|
U
|
Commander::Command#summary= |
|
|
U
|
Commander::Command#examples |
|
|
U
|
Commander::Command#options= |
|
|
U
|
Commander::Command#inspect |
|
|
U
|
Commander::Command#syntax= |
|
|
U
|
Commander::Command#summary |
|
|
U
|
Commander::Command#options |
|
|
U
|
Commander::Command#syntax |
|
|
U
|
Commander::Command#name= |
|
|
U
|
Commander::Command#name |
|
|
U
|
Commander::Platform |
|
|
U
|
Commander::HelpFormatter::TerminalCompact#template |
|
|
U
|
Commander::HelpFormatter::Terminal#render_command |
|
|
U
|
Commander::HelpFormatter::Terminal#render |
|
Let's raise the visibility of documentation in Ruby!
This page is for visionmedia/commander and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
What is the goal of this?
I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk.
Suggestions, feedback, critique: Hit me up on Twitter or via issue.
nch Pages