Let's raise the visibility of code documentation in Ruby! What is this about?

ddfreyne/cri

A tool for building commandline applications – Read the documentation

This page shows an evaluation of the documentation of ddfreyne/cri.

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
Cri::CommandDSL#option
A
Cri::CommandDSL#flag
A
Cri::CommandDSL#required
A
Cri::CommandDSL#optional
A
Cri::Command#commands
Show 73 more ...
A
Cri::Command#hidden
A
Cri::Command
A
Cri::StringFormatter#wrap_and_indent
A
Cri::StringFormatter#to_paragraphs
A
Cri::Command#define_command
A
Cri::CommandDSL#aliases
A
Cri::Command.define
A
Cri
A
Cri::Command#modify
A
Cri::CommandDSL#subcommand
A
Cri::OptionParser#unprocessed_arguments_and_options
A
Cri::Command#global_option_definitions
A
Cri::Command#option_definitions=
A
Cri::Command#option_definitions
A
Cri::OptionParser#raw_arguments
A
Cri::ArgumentArray#initialize
A
Cri::OptionParser#initialize
A
Cri::CommandRunner#arguments
A
Cri::Command.new_basic_help
A
Cri::Command.new_basic_root
A
Cri::CommandDSL#description
A
Cri::OptionParser#arguments
A
Cri::Command#commands_named
A
Cri::OptionParser#delegate=
A
Cri::OptionParser#delegate
A
Cri::CommandRunner#command
A
Cri::CommandRunner#options
A
Cri::Command#supercommand=
A
Cri::CommandDSL#initialize
A
Cri::Command#command_named
A
Cri::CommandDSL#be_hidden
A
Cri::Command#supercommand
A
Cri::Command#description=
A
Cri::OptionParser#options
A
Cri::Command#description
A
Cri::Command#add_command
A
Cri::HelpRenderer#render
A
Cri::CommandRunner#call
A
Cri::OptionParser.parse
A
Cri::CommandDSL#command
A
Cri::Command#initialize
A
Cri::CommandDSL#summary
A
Cri::Command#commands=
A
Cri::OptionParser#stop
A
Cri::ArgumentArray#raw
A
Cri::CommandDSL#runner
A
Cri::Command#aliases=
A
Cri::Command#summary=
A
Cri::CommandDSL#usage
A
Cri::CommandDSL#name
A
Cri::Command#aliases
A
Cri::Command#summary
A
Cri::Command#hidden=
A
Cri::Command#usage=
A
Cri::Command#block=
A
Cri::CommandDSL#run
A
Cri::ArgumentArray
A
Cri::Command#block
A
Cri::Command#usage
A
Cri::Command#name=
A
Cri::CommandRunner
A
Cri::HelpRenderer
A
Cri::OptionParser
A
Cri::Command#name
A
Cri::Command#run
A
Cri::CommandDSL
A
Cri::CommandRunner#initialize
A
Cri::HelpRenderer#initialize
A
Cri::CommandRunner#run
A
Cri::OptionParser#run
A
Cri::Command#run_this
A
Cri::Command#help
A
Cri::Command#<=>
Proper documentation present
B
Cri::StringFormatter#format_as_command
B
Cri::StringFormatter#format_as_option
B
Cri::StringFormatter#format_as_title
Needs work
C
Cri::CoreExtensions::String#formatted_as_command
C
Cri::CoreExtensions::String#formatted_as_option
C
Cri::CoreExtensions::String#formatted_as_title
C
Cri::CoreExtensions::String#wrap_and_indent
C
Cri::CoreExtensions::String#to_paragraphs
Show 1 more ...
C
Cri::CoreExtensions::String
Undocumented
U
Cri::StringFormatter
U
Cri::Platform
U
String

Let's raise the visibility of documentation in Ruby!

This page is for ddfreyne/cri 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?

Sure!

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.

Fork me on GitHub