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

pokonski/public_activity

Easy activity tracking for models - similar to Github's Public Activity – Read the documentation

This page shows an evaluation of the documentation of pokonski/public_activity.

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
PublicActivity
A
UpgradeActivities
A
CreateActivities
A
PublicActivity::Common#create_activity
A
PublicActivity::Config::Block#enabled
Show 49 more ...
A
PublicActivity::Generators::MigrationUpgradeGenerator
A
PublicActivity::ORM::ActiveRecord::Activist#activist
A
PublicActivity::ORM::MongoMapper::Activist#activist
A
PublicActivity::ORM::Mongoid::Activist#activist
A
PublicActivity::Generators::MigrationGenerator
A
PublicActivity::Tracked::ClassMethods#tracked
A
PublicActivity::Generators::ActivityGenerator
A
PublicActivity::ORM::ActiveRecord::Activist
A
PublicActivity::Deactivatable::ClassMethods
A
PublicActivity::ORM::MongoMapper::Activist
A
PublicActivity::ORM::ActiveRecord::Adapter
A
PublicActivity::ORM::Mongoid::Activist
A
PublicActivity::Common#activity_hooks
A
PublicActivity::Tracked::ClassMethods
A
PublicActivity::Common::ClassMethods
A
PublicActivity::Renderable#render
A
PublicActivity::Config#initialize
A
PublicActivity::Generators::Base
A
PublicActivity::StoreController
A
PublicActivity::Deactivatable
A
PublicActivity::Config::Block
A
PublicActivity::ViewHelpers
A
PublicActivity::Renderable
A
PublicActivity::Trackable
A
PublicActivity::Activist
A
PublicActivity::Tracked
A
PublicActivity::Config
A
PublicActivity::Common
A
PublicActivity.config
A
PublicActivity:: #generate_files
A
PublicActivity:: #store_controller_for_public_activity
A
PublicActivity:: #public_activity_off
A
PublicActivity:: #public_activity_on
A
PublicActivity:: #generate_files
A
PublicActivity:: #generate_files
A
PublicActivity::Generators::Base#source_root
A
PublicActivity.without_tracking
A
PublicActivity.get_controller
A
PublicActivity.with_tracking
A
UpgradeActivities.change
A
PublicActivity.enabled=
A
CreateActivities.down
A
CreateActivities.up
A
PublicActivity::Common#activity_parameters_global
A
PublicActivity::Common#activity_recipient_global
A
PublicActivity::Common#activity_owner_global
A
PublicActivity::ORM::ActiveRecord::Trackable
A
PublicActivity::Config.orm=
A
Activity
Proper documentation present
B
PublicActivity::ViewHelpers#render_activity
B
PublicActivity::Config.set
B
PublicActivity::ViewHelpers#single_content_for
B
PublicActivity:: ::Adapter.create_activity
B
PublicActivity:: ::Adapter.create_activity
Show 11 more ...
B
PublicActivity::ORM::ActiveRecord::Trackable.extended
B
PublicActivity::ORM::Mongoid::Adapter.create_activity
B
PublicActivity::Config::Block#table_name
B
PublicActivity::Trackable.included
B
PublicActivity::Activist.included
B
PublicActivity::Renderable#text
B
PublicActivity.set_controller
B
PublicActivity.resolve_value
B
PublicActivity::Config.orm
B
PublicActivity.inherit_orm
B
PublicActivity::Config#orm
Needs work
C
PublicActivity::Tracked#activity
C
PublicActivity::Config::Block#orm
Undocumented
U
PublicActivity:: ::SymbolHash.from_mongo
U
PublicActivity:: #include_default_actions
U
PublicActivity:: #assign_custom_fields
U
PublicActivity::Tracked::ClassMethods#available_options
U
PublicActivity::ORM::MongoMapper::Activity::SymbolHash
Show 19 more ...
U
PublicActivity::Tracked::ClassMethods#assign_globals
U
PublicActivity::Tracked::ClassMethods#assign_hooks
U
PublicActivity::Common#activity_parameters_global=
U
PublicActivity::Common#activity_recipient_global=
U
PublicActivity::Common#activity_owner_global=
U
PublicActivity::Renderable#prepare_parameters
U
PublicActivity::ORM::MongoMapper::Trackable
U
PublicActivity::ORM::MongoMapper::Adapter
U
PublicActivity::Renderable#prepare_locals
U
PublicActivity::ORM::Mongoid::Trackable
U
PublicActivity::Renderable#partial_path
U
PublicActivity::Common#activity_hooks=
U
PublicActivity::Renderable#layout_path
U
PublicActivity::ORM::Mongoid::Adapter
U
PublicActivity::Config#table_name=
U
PublicActivity::Config#table_name
U
PublicActivity::Config#enabled=
U
PublicActivity::Config#enabled
U
PublicActivity::Config::@@orm

Let's raise the visibility of documentation in Ruby!

This page is for pokonski/public_activity 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