Let's raise the visibility of code documentation in Ruby!
Inch CI is here! Make your own badge with the new CI service: http://inch-ci.org

rkh/mustermann

your personal string matching expert – Read the documentation

This page shows an evaluation of the documentation of rkh/mustermann.

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
Mustermann::Expander#cast
A
Mustermann
A
Mustermann::Expander#add
A
Mustermann::RegexpBased#regexp
A
Mustermann::Pattern.new
Show 37 more ...
A
Mustermann::ToPattern#to_pattern
A
Mustermann::Pattern.supported_options
A
Mustermann::SimpleMatch#captures
A
Mustermann::SimpleMatch#names
A
Mustermann::SimpleMatch#to_s
A
Mustermann::Expander#expand
A
Mustermann::Router::Simple
A
Mustermann::Pattern#expand
A
Mustermann::Router::Rack
A
Mustermann::Pattern#to_s
A
Mustermann::Mapper#to_h
A
Mustermann::ToPattern
A
Mustermann::Expander
A
Mustermann::Mapper
A
Mustermann.new
A
Mustermann::Router::Simple#default=
A
Mustermann::Router::Simple#default
A
Mustermann::Mapper#update
A
Mustermann::Mapper#[]=
A
Mustermann::Router::Simple#call
A
Mustermann::Pattern#named_captures
A
Mustermann::Pattern#names
A
Mustermann::Pattern#match
A
Mustermann::AST::Pattern
A
Mustermann::SimpleMatch
A
Mustermann::RegexpBased
A
Mustermann::Pattern#===
A
Mustermann::Pattern#=~
A
Mustermann::Extension
A
Mustermann::Template
A
Mustermann::Identity
A
Mustermann::Pattern
A
Mustermann::Regular
A
Mustermann::Simple
A
Mustermann::Shell
A
Mustermann.[]
A
Mustermann::AST::Pattern#expand
Proper documentation present
B
Mustermann::Mapper#convert
B
Mustermann::Pattern#initialize
B
Mustermann::Router::Rack#initialize
B
Mustermann::Pattern#params
B
Mustermann::Router::Simple#[]
Show 4 more ...
B
Mustermann::Router::Simple#[]=
B
Mustermann::RegexpBased#initialize
B
Mustermann::Regular#initialize
B
Mustermann::Shell#initialize
Needs work
C
Mustermann::SimpleMatch#[]
C
Mustermann::Expander#hash
C
Mustermann::Expander#==
Undocumented
U
Mustermann::Router::Simple#initialize
U
Mustermann::Expander#initialize
U
Mustermann::Router::Simple#on
U
Mustermann::Mapper#initialize
U
Mustermann::Expander#additional_values
Show 1 more ...
U
Mustermann::Expander#patterns

Let's raise the visibility of documentation in Ruby!

This page is for rkh/mustermann 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