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

ricardovaleriano/hashing

Gives you an easy way to specify which instances vars of your objects should be used as `key => value` to serialize it into a hash returned by the `#to_h` method. Also gives you a `YourClass::from_hash` to reconstruct the instances. – Read the documentation

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

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
Hasherize
A
Hasherize#initialize
A
Hashing::Hasherizer#from_hash
A
Hashing::UnconfiguredIvar
A
Hashing::Hasherizer#ivars
Show 6 more ...
A
Hashing::Ivar#from_hash
A
Hashing::Hasherizer
A
Hashing::Ivar#to_h
A
Hashing::Ivar
A
Hashing#to_h
A
Hashing::Ivar#initialize
Proper documentation present
B
Hashing.included
B
Hasherize#included
Needs work
Undocumented
U
Hashing
U
Hashing::UnconfiguredIvar#initialize
U
Hashing::Ivar#to_sym
U
Hashing::Ivar#to_s
U
Hashing::Ivar#name
Show 1 more ...
U
Hashing#meta_data

Let's raise the visibility of documentation in Ruby!

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