rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#1410 (all)
Ruby (change)
35 seconds
24 days 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::Relation::Commands#command N
U
ROM::Configuration#initialize N
U
ROM.container N
U
ROM::Plugins::Relation::Instrumentation::ClassInterface#instrument Ne
U
ROM::Plugins::Relation::Instrumentation#instrument Ne
U
ROM::Commands::Graph::InputEvaluator#call Ne
U
ROM::Notifications::Publisher#subscribe Ne
U
ROM::Notifications::Listener#subscribe Ne
U
ROM::Environment#initialize Ne
U
ROM::AutoCurry#auto_curry Ne
U
ROM::Relation::Wrap#wrap Ne
U
ROM::Types.Constructor Ne
U
ROM::Commands::Graph::InputEvaluator.extract_excluded_keys Ne
U
ROM::Plugins::Relation::Instrumentation::ClassInterface Ne
U
ROM::AutoRegistrationStrategies::CustomNamespace#call Ne
U
ROM::AutoRegistrationStrategies::WithNamespace#call Ne
U
ROM::Plugins::Relation::Changeset::InstanceMethods Ne
U
ROM::Commands::Graph::InputEvaluator#excluded_keys Ne
U
ROM::Commands::Graph::InputEvaluator#exclude_proc Ne
U
ROM::Commands::Graph::InputEvaluator.exclude_proc Ne
U
ROM::AutoRegistrationStrategies::NoNamespace#call Ne
U
ROM::AutoRegistrationStrategies::CustomNamespace Ne
U
ROM::Commands::Graph::InputEvaluator#tuple_path Ne
U
ROM::Commands::Graph::InputEvaluator#initialize Ne
U
ROM::AutoRegistrationStrategies::WithNamespace Ne
U
ROM::Associations::Definitions::Abstract#type Ne
U
ROM::AutoRegistrationStrategies::NoNamespace Ne
U
ROM::Associations::ManyToMany#join_relation Ne
U
ROM::Commands::Graph::InputEvaluator.build Ne
U
ROM::Associations::Definitions::ManyToMany Ne
U
ROM::Associations::Abstract#combine_keys Ne
U
ROM::Notifications::EventBus#initialize Ne
U
ROM::Associations::Abstract#foreign_key Ne
U
ROM::Associations::Abstract#apply_view Ne
U
ROM::AdapterNotPresentError#initialize Ne
U
ROM::Notifications::EventBus#listeners Ne
U
ROM::Relation::ViewDSL#relation_block Ne
U
ROM::Notifications::Publisher#trigger Ne
U
ROM::InlineCreateContainer#initialize Ne
U
ROM::ElementNotFoundError#set_message Ne
U
ROM::Schema::AssociationsDSL#registry Ne
U
ROM::Associations::ManyToMany#through Ne
U
ROM::Notifications::Event#initialize Ne
U
ROM::ElementNotFoundError#initialize Ne
U
ROM::Commands::Graph::InputEvaluator Ne
U
ROM::Changeset::Associated#associate Ne
U
ROM::AutoCurry#auto_curried_methods Ne
U
ROM::Repository::ClassInterface#new Ne
U
ROM::Schema::AssociationsDSL#source Ne
U
ROM::Notifications::EventBus#events Ne
U
ROM::Associations::Abstract#result Ne
U
ROM::Relation::ClassInterface#name Ne
U
ROM::Associations::ManyToMany#call Ne
U
ROM::Associations::OneToMany#call Ne
U
ROM::Notifications#register_event Ne
U
ROM::Relation::ViewDSL#new_schema Ne
U
ROM::Notifications::Event#trigger Ne
U
ROM::Notifications::Event#payload Ne
U
ROM::Associations::ManyToOne#call Ne
U
ROM::Schema::DSL#associations_dsl Ne
U
ROM::Configuration#notifications Ne
U
ROM::Associations::Abstract#view Ne
U
ROM::Associations::Abstract#name Ne
U
ROM::CreateContainer#initialize Ne
U
ROM::Relation::Graph#with_nodes Ne
U
ROM::Notifications::EventBus#id Ne
U
ROM::Associations::Abstract.new Ne
U
ROM::AutoCurry#auto_curry_guard Ne
U
ROM::AutoRegistration#relations Ne
U
ROM::Associations::Abstract#key Ne
U
ROM::CreateContainer#container Ne
U
ROM::Types::Methods#ForeignKey Ne
U
ROM::Relation::Combined#to_ast Ne
U
ROM::Configuration#environment Ne
U
ROM::Associations::Abstract#as Ne
U
ROM::AutoRegistration#commands Ne
U
ROM::Schema#primary_key_names Ne
U
ROM::AutoRegistration#mappers Ne
U
ROM::Relation::ClassInterface Ne
U
ROM::Associations::ManyToMany Ne
U
ROM::Environment#gateways_map Ne
U
ROM::Notifications::Publisher Ne
U
ROM::Associations::OneToMany Ne
U
ROM::Notifications::EventBus Ne
U
ROM::Notifications::Event#id Ne
U
ROM::Schema#primary_key_name Ne
U
ROM::Associations::ManyToOne Ne
U
ROM::Notifications::Listener Ne
U
ROM::Configurable::Config#[] Ne
U
ROM::Notifications.event_bus Ne
U
ROM::Notifications::Event#[] Ne
U
ROM::Setup#auto_registration Ne
U
ROM::Relation::ViewDSL#name Ne
U
ROM::Commands::Lazy::Update Ne
U
ROM::Commands::Lazy::Create Ne
U
ROM::Configurable#configure Ne
U
ROM::Commands::Lazy::Delete Ne
U
ROM::Schema::DSL#definition Ne
U
ROM::AdapterNotPresentError Ne
U
ROM::Relation::Graph#map_to Ne
U
ROM::Schema::DSL#attributes Ne
U
ROM::Changeset::Restricted Ne
U
ROM::Repository::Root#root Ne
U
ROM::InlineCreateContainer Ne
U
ROM::ElementNotFoundError Ne
U
ROM::Environment#gateways Ne
U
ROM::Notifications::Event Ne
U
ROM::Repository#relations Ne
U
ROM::Schema::DSL#plugins Ne
U
ROM::Container#relations Ne
U
ROM::Relation#eager_load Ne
U
ROM::Configuration#setup Ne
U
ROM::Container#gateways Ne
U
ROM::Gateway#connection Ne
U
ROM::Container#commands Ne
U
ROM::Relation::Curried Ne
U
ROM::Container#mappers Ne
U
ROM::Types.Definition Ne
U
ROM::RelationRegistry Ne
U
ROM::AutoRegistration Ne
U
ROM::CreateContainer Ne
U
ROM::Types::Methods Ne
U
ROM::Memory::Schema Ne
U
ROM::AssociationSet Ne
U
ROM::Relation#node Ne
U
ROM::Configuration Ne
U
ROM::Notifications Ne
U
ROM::Schema::DSL Ne
U
ROM::AutoCurry Ne
U
ROM::Types Ne
U
ROM::Setup Ne
U
ROM::Associations::ManyToMany#target_key E
U
ROM::Associations::ManyToMany#source_key E
U
ROM::Associations::ManyToMany#join_assoc E
U
ROM::Associations::ManyToOne#source_key E
U
ROM::Associations::ManyToOne#target_key E
U
ROM::Associations::OneToMany#target_key E
U
ROM::Associations::OneToMany#source_key E
U
ROM::CommandRegistry.element_not_found_error E
U
ROM::Associations::ManyToMany#foreign_key E
U
ROM::Relation::ClassInterface#set_schema! E
U
ROM::Associations::ManyToOne#foreign_key E
U
ROM::Associations::OneToMany#foreign_key E
U
ROM::AutoRegistrationStrategies::Base E
U
ROM::Schema#finalize_associations! E
U
ROM::Plugins::Relation::Changeset E
U
ROM::StructCompiler#call E
U
ROM::Schema#finalize! E
U
ROM::Session#commit! 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.