rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#1301 (all)
Ruby (change)
13 seconds
over 2 years ago

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.

Undocumented
U
ROM::Configuration#use N
U
ROM::Commands::Graph::Builder::Node#command N
U
ROM::Plugins::Relation::View::DSL#header N
U
ROM::Configuration#initialize N
U
ROM::Schema#attributes N
U
ROM.container N
U
ROM::Commands::Graph::Builder::Node#restrict Ne
U
ROM::Plugins::Relation::View::DSL#initialize Ne
U
ROM::Plugins::Relation::View::DSL#relation Ne
U
ROM::Environment#initialize Ne
U
ROM::Commands::Graph::Builder::Node::Restriction#relation= Ne
U
ROM::Commands::Graph::Builder::Node::Restriction#relation Ne
U
ROM::Commands::Graph::Builder::Node::Restriction#proc= Ne
U
ROM::Commands::Graph::Builder::Node::Command#relation= Ne
U
ROM::AutoRegistrationStrategies::CustomNamespace#call Ne
U
ROM::Commands::Graph::Builder::Node::Command#relation Ne
U
ROM::Commands::Graph::Builder::Node::Restriction#proc Ne
U
ROM::AutoRegistrationStrategies::WithNamespace#call Ne
U
ROM::Commands::Graph::Builder::CommandNode#command Ne
U
ROM::Commands::Graph::Builder::Node::Command#proc= Ne
U
ROM::Commands::Graph::Builder::Node::Command#name= Ne
U
ROM::Commands::Graph::Builder::Node::Command#proc Ne
U
ROM::AutoRegistrationStrategies::NoNamespace#call Ne
U
ROM::Commands::Graph::Builder::Node::Command#key= Ne
U
ROM::Commands::Graph::Builder::Node::Command#name Ne
U
ROM::Commands::Graph::Builder::Node::Command#key Ne
U
ROM::AutoRegistrationStrategies::CustomNamespace Ne
U
ROM::Plugins::Relation::View::DSL#relation_block Ne
U
ROM::AutoRegistrationStrategies::WithNamespace Ne
U
ROM::AutoRegistrationStrategies::NoNamespace Ne
U
ROM::Plugins::Relation::View::DSL#attributes Ne
U
ROM::Plugins::Relation::View::ClassInterface Ne
U
ROM::Commands::Graph::Builder::Node#to_ast Ne
U
ROM::Commands::Graph::Builder#initialize Ne
U
ROM::AdapterNotPresentError#initialize Ne
U
ROM::Plugins::Relation::View::DSL#name Ne
U
ROM::Plugins::Relation::View::DSL#call Ne
U
ROM::InlineCreateContainer#initialize Ne
U
ROM::Plugins::Relation::KeyInference Ne
U
ROM::Plugins::Relation::View::DSL Ne
U
ROM::AutoRegistration#initialize Ne
U
ROM::Relation::Curried#relation Ne
U
ROM::AutoRegistration#directory Ne
U
ROM::CreateContainer#initialize Ne
U
ROM::AutoRegistration#relations Ne
U
ROM::AutoRegistration#commands Ne
U
ROM::Types::Methods#ForeignKey Ne
U
ROM::Configuration#environment Ne
U
ROM::CreateContainer#container Ne
U
ROM::Environment#gateways_map Ne
U
ROM::AutoRegistration#mappers Ne
U
ROM::Relation::ClassInterface Ne
U
ROM::Plugins::Relation::View Ne
U
ROM::Configurable::Config#[] Ne
U
ROM::Setup#auto_registration Ne
U
ROM::Configurable#configure Ne
U
ROM::Relation::Curried#name Ne
U
ROM::AutoRegistration#globs Ne
U
ROM::AdapterNotPresentError Ne
U
ROM::Schema::DSL#attributes Ne
U
ROM::InlineCreateContainer Ne
U
ROM::Environment#gateways Ne
U
ROM::Schema::DSL#inferrer Ne
U
ROM::Container#disconnect Ne
U
ROM::Configuration#setup Ne
U
ROM::Schema#associations Ne
U
ROM::Schema#primary_key Ne
U
ROM::Relation::Curried Ne
U
ROM::Relation#dataset Ne
U
ROM::AutoRegistration Ne
U
ROM::RelationRegistry Ne
U
ROM::Schema::DSL#name Ne
U
ROM::CreateContainer Ne
U
ROM::Relation#schema Ne
U
ROM::Schema#inferrer Ne
U
ROM::AssociationSet Ne
U
ROM::Types::Methods Ne
U
ROM::Configuration Ne
U
ROM::Schema::DSL Ne
U
ROM::Schema#name Ne
U
ROM::Setup Ne
U
ROM::Types Ne
U
ROM::Commands::Graph::Builder::RestrictionNode#command E
U
ROM::AutoRegistrationStrategies::Base E
U
ROM::Plugins::Relation E

Let's raise the visibility of documentation in Open Source!

This page is for rom-rb/rom 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! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

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.