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

ricardovaleriano/optioning

An object oriented way to retrieve, store, filter, transform and deprecate `options` passed to a method. Where `options` are the keys in our beloved `Hash` as last parameter in a method call. – Read the documentation

This page shows an evaluation of the documentation of ricardovaleriano/optioning.

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
Deprecation
A
Optioning#deprecate
A
Optioning#recognize
A
Optioning#unrecognized_warn
A
Optioning#deprecation_warn
Show 5 more ...
A
Optioning#process
A
Deprecation#warn
A
Optioning#values
A
Optioning#raw
A
Optioning#on
Proper documentation present
B
Deprecation#initialize
B
Optioning#initialize
Needs work
Undocumented
U
Optioning
U
Deprecation#replacement
U
Deprecation#caller=
U
Deprecation#version
U
Deprecation#option
Show 1 more ...
U
Deprecation#date

Let's raise the visibility of documentation in Ruby!

This page is for ricardovaleriano/optioning 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