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.

Seems really good
A
ROM::Repository::Root#aggregate N
A
ROM::Relation::ClassInterface#view N
A
ROM::Changeset::Stateful#map N
A
ROM::Relation::ClassInterface#schema N
A
ROM N
A
ROM::Relation#map_with N
A
ROM::Gateway.setup N
A
ROM::Transaction#rollback! N
A
ROM::Associations::Definitions::Abstract.new N
A
ROM::Repository::ClassInterface#commands N
A
ROM::Relation::Materializable#one! N
A
ROM::Relation::Materializable#to_a N
A
ROM::Schema::Attribute#inspect N
A
ROM::Schema::Attribute#aliased N
A
ROM::Changeset::Stateful#to_a N
A
ROM::Changeset::Stateful#to_h N
A
ROM::Relation::Loaded#one! N
A
ROM::Schema#merge N
A
ROM::Schema N
A
ROM::InternalPluginRegistry#fetch N
A
ROM::Associations::Definitions::Abstract Ne
A
ROM::Schema::AssociationsDSL#one_to_many Ne
A
ROM::Memory::Relation#project Ne
A
ROM::ConfigurationDSL#plugin Ne
A
ROM::Relation#combine_with Ne
A
ROM::Commands::Graph#call Ne
A
ROM::Schema::Attribute Ne
A
ROM::Schema#project Ne
A
ROM::Schema#exclude Ne
A
ROM::Relation Ne
A
ROM::Changeset::Restricted#by_pk Ne
A
ROM::Plugins::Schema::Timestamps::DSL#timestamps Ne
A
ROM::Schema::DSL#associations Ne
A
ROM::Changeset::Stateful#extend Ne
A
ROM::Associations::Definitions::Abstract#foreign_key Ne
A
ROM::Associations::Definitions::Abstract#override Ne
A
ROM::Associations::Definitions::Abstract#relation Ne
A
ROM::Associations::Definitions::Abstract#result Ne
A
ROM::Associations::Definitions::Abstract#source Ne
A
ROM::Associations::Definitions::Abstract#target Ne
A
ROM::Associations::Definitions::Abstract#alias Ne
A
ROM::Associations::Definitions::Abstract#name Ne
A
ROM::Associations::Definitions::Abstract#view Ne
A
ROM::ConfigurationPlugins::ConfigurationDSL Ne
A
ROM::Initializer::InstanceMethods#options Ne
A
ROM::Lint::TestEnumerableDataset#dataset Ne
A
ROM::Lint::EnumerableDataset#initialize Ne
A
ROM::Plugins::Relation::Instrumentation Ne
A
ROM::Changeset::Associated#associations Ne
A
ROM::Associations::Abstract#definition Ne
A
ROM::Plugins::Relation::RegistryReader Ne
A
ROM::Associations::Abstract#relations Ne
A
ROM::Lint::TestEnumerableDataset#data Ne
A
ROM::Relation::Materializable#first Ne
A
ROM::Relation::Loaded#primary_keys Ne
A
ROM::Changeset::Associated#command Ne
A
ROM::Associations::Abstract#source Ne
A
ROM::Repository::ClassInterface#[] Ne
A
ROM::Schema::Attribute#to_read_ast Ne
A
ROM::CommandCompiler#notifications Ne
A
ROM::Associations::Abstract#target Ne
A
ROM::Changeset::Associated#commit Ne
A
ROM::Lint::TestGateway#identifier Ne
A
ROM::Repository#struct_namespace Ne
A
ROM::Plugins::Schema::Timestamps Ne
A
ROM::Lint::TestEnumerableDataset Ne
A
ROM::Changeset::Associated#left Ne
A
ROM::Repository.relation_reader Ne
A
ROM::Schema::Attribute#prefixed Ne
A
ROM::Changeset::Update#original Ne
A
ROM::Repository::ClassInterface Ne
A
ROM::Changeset::Stateful.extend Ne
A
ROM::Lint::TestGateway#gateway Ne
A
ROM::Schema::Attribute#wrapped Ne
A
ROM::EnumerableDataset#to_ary Ne
A
ROM::Schema::Attribute#target Ne
A
ROM::Schema::Attribute#to_ast Ne
A
ROM::Schema::Attribute#source Ne
A
ROM::CommandCompiler#registry Ne
A
ROM::Relation::Materializable Ne
A
ROM::Changeset::Stateful#data Ne
A
ROM::Memory::Commands::Create Ne
A
ROM::Memory::Commands::Update Ne
A
ROM::CommandRegistry#map_with Ne
A
ROM::Memory::Commands::Delete Ne
A
ROM::CommandCompiler#adapter Ne
A
ROM::Lint::EnumerableDataset Ne
A
ROM::CommandCompiler#plugins Ne
A
ROM::Schema::Attribute#alias Ne
A
ROM::Changeset::Stateful.map Ne
A
ROM::Relation::Loaded#to_ary Ne
A
ROM::Schema::AssociationsDSL Ne
A
ROM::Relation::Combined#node Ne
A
ROM::Associations::Abstract Ne
A
ROM::Schema::Attribute#name Ne
A
ROM::Changeset#command_type Ne
A
ROM::Changeset::Update#diff Ne
A
ROM::Relation::Combined.new Ne
A
ROM::Relation::Curried#to_a Ne
A
ROM::Schema::Attribute#meta Ne
A
ROM::Relation::Loaded#pluck Ne
A
ROM::Repository#auto_struct Ne
A
ROM::Relation#associations Ne
A
ROM::Pipeline::Operator#>> Ne
A
ROM::Lint::TestGateway#uri Ne
A
ROM::Schema::Attribute#key Ne
A
ROM::Changeset::Associated Ne
A
ROM::CommandCompiler#meta Ne
A
ROM::Container#disconnect Ne
A
ROM::Repository#container Ne
A
ROM::Commands::Composite Ne
A
ROM::Schema#associations Ne
A
ROM::Changeset::Stateful Ne
A
ROM::Relation::Composite Ne
A
ROM::Repository#inspect Ne
A
ROM::Changeset#relation Ne
A
ROM::CommandCompiler#id Ne
A
ROM::Schema#primary_key Ne
A
ROM::Relation::Combined Ne
A
ROM::Changeset#inspect Ne
A
ROM::Relation::ViewDSL Ne
A
ROM::EnumerableDataset Ne
A
ROM::Schema#attributes Ne
A
ROM::Lint::TestGateway Ne
A
ROM::Memory::Relation Ne
A
ROM::Relation::Loaded Ne
A
ROM::ConfigurationDSL Ne
A
ROM::Repository::Root Ne
A
ROM::Changeset#commit Ne
A
ROM::Relation#dataset Ne
A
ROM::Relation#schemas Ne
A
ROM::Relation#mappers Ne
A
ROM::Schema#inferrer Ne
A
ROM::Gateway#adapter Ne
A
ROM::Memory::Gateway Ne
A
ROM::Relation#to_ast Ne
A
ROM::CommandRegistry Ne
A
ROM::Relation::Graph Ne
A
ROM::Memory::Dataset Ne
A
ROM::Relation#schema Ne
A
ROM::Gateway#logger Ne
A
ROM::Changeset#with Ne
A
ROM::Relation::Wrap Ne
A
ROM::Schema#rename Ne
A
ROM::Schema#prefix Ne
A
ROM::Schema#to_ast Ne
A
ROM::Relation#name Ne
A
ROM::Schema#to_ary Ne
A
ROM::Lint::Gateway Ne
A
ROM::Relation#new Ne
A
ROM::Lint::Linter Ne
A
ROM::Schema#wrap Ne
A
ROM::Environment Ne
A
ROM::Schema#to_h Ne
A
ROM::Struct#to_s Ne
A
ROM::Schema#name Ne
A
ROM::Lint::Test Ne
A
ROM::OpenStruct Ne
A
ROM::Container Ne
A
ROM::Processor Ne
A
ROM::Global Ne
A
ROM::Lint::Gateway#initialize Ne
A
ROM::Lint::Gateway#lint_transaction_support Ne
A
ROM::Relation::ClassInterface#relation_name Ne
A
ROM::Lint::Gateway#lint_dataset_predicate Ne
A
ROM::Lint::Gateway#lint_dataset_reader Ne
A
ROM::Lint::EnumerableDataset#lint_each Ne
A
ROM::Lint::Gateway#lint_adapter_reader Ne
A
ROM::Lint::EnumerableDataset#lint_to_a Ne
A
ROM::Lint::Gateway#lint_gateway_setup Ne
A
ROM::Lint::EnumerableDataset#dataset Ne
A
ROM::Lint::EnumerableDataset#data Ne
A
ROM::Lint::Gateway#identifier Ne
A
ROM::Repository.auto_struct Ne
A
ROM::Lint::Linter.each_lint Ne
A
ROM::Lint::Gateway#gateway Ne
A
ROM::Gateway#disconnect Ne
A
ROM::Lint::Gateway#uri Ne
A
ROM::Schema::DSL#use Ne
A
ROM::Relation#map_to Ne
A
ROM::Struct#fetch Ne
A
ROM::Relation#[] Ne
A
ROM::Relation::ViewDSL#relation Ne
A
ROM::Relation::ViewDSL#schema Ne
A
ROM::Schema::AssociationsDSL#many_to_many E
A
ROM::Schema::AssociationsDSL#many_to_one E
A
ROM::Schema::AssociationsDSL#belongs_to E
A
ROM::Schema::AssociationsDSL#one_to_one E
A
ROM::Schema::AssociationsDSL#has_one E
A
ROM::Relation::Materializable#one E
A
ROM::Relation::ClassInterface#use E
A
ROM::Changeset.command_type E
A
ROM::Repository::Root.root E
A
ROM::Relation::Loaded#one E
A
ROM::CommandCompiler#call E
A
ROM::Gateway#use_logger E
A
ROM::Changeset.relation E
A
ROM::Lint::Linter#lint E
A
ROM::Changeset::Create E
A
ROM::Changeset::Update E
A
ROM::ArrayDataset E
A
ROM::Repository E
A
ROM::Schema#[] E
A
ROM::Changeset E
A
ROM::Gateway E
A
ROM::Struct E
A
ROM::Relation#each E
A
ROM::Commands::Lazy#>> E
A
ROM::Changeset::Stateful#inspect E
A
ROM::Changeset::Stateful#command E
A
ROM::Memory::Gateway#use_logger E
A
ROM::Changeset::Create#command E
A
ROM::Memory::Gateway#logger E
A
ROM::PluginRegistryBase#[] E
A
ROM::Relation::Wrap#right E
A
ROM::Relation::Wrap#left E
A
ROM::Relation#to_a E
A
ROM::Relation#call E
A
ROM::ConfigurationPluginRegistry#fetch 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.