CanCanCommunity/cancancan

Continuation of CanCan, the authorization Gem for Ruby on Rails.

Build #12 (all) Revision dbc6bfeb Source github.com Documentation rubydoc.info

This page shows an evaluation of the project's documentation.

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.

Read the docs

Seems really good
A
CanCan::Ability Ne
A
CanCan::ModelAdapters::ActiveRecordAdapter#conditions Ne
A
CanCan::ControllerAdditions#current_ability Ne
A
CanCan::Ability#aliased_actions Ne
A
CanCan::ControllerAdditions Ne
Show 4 more ...
A
CanCan::ModelAdditions Ne
A
CanCan::AccessDenied Ne
A
CanCan::ModelAdapters::ActiveRecordAdapter#joins Ne
A
CanCan::Ability#clear_aliased_actions Ne
Proper documentation present
B
CanCan::ControllerAdditions#authorize! N
B
CanCan::Ability#authorize! N
B
CanCan::Ability#cannot N
B
CanCan::Ability#can N
B
CanCan::ControllerAdditions::ClassMethods#authorize_resource Ne
Show 13 more ...
B
CanCan::ControllerAdditions::ClassMethods#load_resource Ne
B
CanCan::Ability#alias_action Ne
B
CanCan::ControllerAdditions::ClassMethods#skip_load_and_authorize_resource Ne
B
CanCan::ControllerAdditions::ClassMethods#load_and_authorize_resource Ne
B
CanCan::ControllerAdditions::ClassMethods#skip_authorization_check Ne
B
CanCan::ControllerAdditions::ClassMethods#skip_authorize_resource Ne
B
CanCan::ControllerAdditions::ClassMethods#skip_load_resource Ne
B
CanCan::ControllerAdditions::ClassMethods#check_authorization Ne
B
CanCan::ModelAdditions::ClassMethods#accessible_by Ne
B
CanCan::ModelAdapters::AbstractAdapter.find Ne
B
CanCan::Ability#validate_target Ne
B
CanCan::ModelAdapters::DataMapperAdapter.find E
B
CanCan::ModelAdapters::SequelAdapter.find E
Please take a look
Undocumented
U
CanCan::ControllerAdditions#unauthorized! N
U
Ability N
U
CanCan::ControllerAdditions::ClassMethods#skip_authorization Ne
U
CanCan Ne
U
CanCan::ModelAdapters::ActiveRecordAdapter#tableized_conditions Ne
Show 32 more ...
U
CanCan::ControllerAdditions::ClassMethods#cancan_resource_class Ne
U
CanCan::ModelAdapters::ActiveRecordAdapter#database_records Ne
U
CanCan::ControllerAdditions::ClassMethods#cancan_skipper Ne
U
CanCan::ModelAdapters::AbstractAdapter#database_records Ne
U
Cancan::Generators::AbilityGenerator#generate_ability Ne
U
CanCan::ModelAdapters::AbstractAdapter.adapter_class Ne
U
CanCan::ModelAdapters::AbstractAdapter#initialize Ne
U
CanCan::ModelAdapters::ActiveRecord3Adapter Ne
U
CanCan::ModelAdapters::ActiveRecord4Adapter Ne
U
CanCan::ModelAdapters::ActiveRecordAdapter Ne
U
CanCan::ControllerAdditions::ClassMethods Ne
U
CanCan::ModelAdapters::DataMapperAdapter Ne
U
CanCan::ModelAdapters::AbstractAdapter Ne
U
CanCan::ModelAdapters::MongoidAdapter Ne
U
CanCan::AccessDenied#default_message= Ne
U
CanCan::ModelAdapters::SequelAdapter Ne
U
CanCan::Ability#unauthorized_message Ne
U
CanCan::ModelAdditions::ClassMethods Ne
U
Cancan::Generators::AbilityGenerator Ne
U
CanCan::AccessDenied#initialize Ne
U
CanCan::Ability#attributes_for Ne
U
CanCan::Ability#model_adapter Ne
U
CanCan::AccessDenied#subject Ne
U
CanCan::AccessDenied#action Ne
U
CanCan::AccessDenied#to_s Ne
U
CanCan::Ability#merge Ne
U
Ability#initialize Ne
U
CanCanCan E
U
Cancan E
U
CanCan::ModelAdapters::DataMapperAdapter#database_records E
U
CanCan::ModelAdapters::MongoidAdapter#database_records E
U
CanCan::ModelAdapters::SequelAdapter#database_records E

Let's raise the visibility of documentation in Ruby!

This page is for CanCanCommunity/cancancan and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure!

Can I configure a webhook for continuous integration?

Of course! Learn how ...

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.

An open source project, created by René Föhring (@rrrene), based on Inch.