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

lotus/utils

Ruby core extentions and class utilities for Lotus – Read the documentation

This page shows an evaluation of the documentation of lotus/utils.

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
Lotus::Utils::Hash#symbolize!
A
Lotus::Utils::Class.load!
A
Lotus:: #class_attribute
A
Lotus::Utils::String#tokenize
A
Lotus::Utils::PathPrefix#relative_join
Show 26 more ...
A
Lotus::Utils::PathPrefix#initialize
A
Lotus::Utils::IO.silence_warnings
A
Lotus::Utils::String#demodulize
A
Lotus::Utils::String#initialize
A
Lotus::Utils::Hash#initialize
A
Lotus::Utils::String#classify
A
Lotus::Utils::PathPrefix#join
A
Lotus::Utils::PathPrefix
A
Lotus::Utils::Kernel
A
Lotus::Utils::String
A
Lotus::Utils::Class
A
Lotus::Utils::Hash
A
Lotus::Utils::IO
A
Lotus::Utils::String#underscore
A
Lotus::Utils::Kernel.Pathname
A
Lotus::Utils::Kernel.DateTime
A
Lotus::Utils::ClassAttribute
A
Lotus::Utils::Kernel.Boolean
A
Lotus::Utils::Kernel.Integer
A
Lotus::Utils::Kernel.String
A
Lotus::Utils::Kernel.Float
A
Lotus::Utils::Kernel.Array
A
Lotus::Utils::Kernel.Date
A
Lotus::Utils::Kernel.Time
A
Lotus::Utils::Kernel.Set
A
Lotus::Utils
Proper documentation present
Needs work
C
Lotus::Utils::ClassAttribute::ClassMethods#inherited
Undocumented
U
Lotus::Utils::ClassAttribute::ClassMethods
U
Lotus::Utils::ClassAttribute.included
U
Lotus::Utils::Kernel.Hash
U
Lotus

Let's raise the visibility of documentation in Ruby!

This page is for lotus/utils 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