rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#1407 (all)
Ruby (change)
19 seconds
4 months 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::Relation::ClassInterface#view N
A
ROM::Relation::ClassInterface#schema N
A
ROM N
A
ROM::Gateway.setup N
A
ROM::Transaction#rollback! 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::Relation::Loaded#one! N
A
ROM::Schema#merge N
A
ROM::Schema N
A
ROM::InternalPluginRegistry#fetch N
A
ROM::Memory::Relation#project Ne
A
ROM::Commands::Result#to_ary Ne
A
ROM::Commands::Graph#call Ne
A
ROM::Container#relation Ne
A
ROM::Schema::Attribute Ne
A
ROM::Relation#combine Ne
A
ROM::Schema#project Ne
A
ROM::Schema#exclude 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::RegistryReader Ne
A
ROM::Lint::TestEnumerableDataset#data Ne
A
ROM::Relation::Materializable#first Ne
A
ROM::Relation::Loaded#primary_keys Ne
A
ROM::Gateway#extend_command_class Ne
A
ROM::Lint::TestGateway#identifier Ne
A
ROM::Lint::TestEnumerableDataset Ne
A
ROM::Schema::Attribute#prefixed Ne
A
ROM::Commands::Result::Failure Ne
A
ROM::Schema::Attribute#wrapped Ne
A
ROM::Lint::TestGateway#gateway Ne
A
ROM::Commands::Result::Success Ne
A
ROM::EnumerableDataset#to_ary Ne
A
ROM::Memory::Commands::Delete Ne
A
ROM::Relation::Materializable Ne
A
ROM::Schema::Attribute#source Ne
A
ROM::Memory::Commands::Create Ne
A
ROM::Memory::Commands::Update Ne
A
ROM::Schema::Attribute#target Ne
A
ROM::Commands::Graph::Builder Ne
A
ROM::Schema::Attribute#alias Ne
A
ROM::Relation::Loaded#to_ary Ne
A
ROM::Lint::EnumerableDataset Ne
A
ROM::Relation::Curried#name Ne
A
ROM::Schema::Attribute#name Ne
A
ROM::Relation::Curried#to_a Ne
A
ROM::Schema::Attribute#meta Ne
A
ROM::Relation::Loaded#pluck Ne
A
ROM::Relation#associations Ne
A
ROM::Pipeline::Operator#>> Ne
A
ROM::Lint::TestGateway#uri Ne
A
ROM::Container#disconnect Ne
A
ROM::Commands::Composite Ne
A
ROM::Relation::Composite Ne
A
ROM::CommandRegistry#try Ne
A
ROM::Container#gateways Ne
A
ROM::CommandRegistry#[] Ne
A
ROM::CommandRegistry#as Ne
A
ROM::Schema#primary_key Ne
A
ROM::Lint::TestGateway Ne
A
ROM::Container#command Ne
A
ROM::EnumerableDataset Ne
A
ROM::Relation#dataset Ne
A
ROM::Relation#schemas Ne
A
ROM::ConfigurationDSL Ne
A
ROM::Relation::Loaded Ne
A
ROM::Memory::Relation Ne
A
ROM::Commands::Result Ne
A
ROM::Relation#mappers Ne
A
ROM::Relation::Graph Ne
A
ROM::CommandRegistry Ne
A
ROM::Memory::Dataset Ne
A
ROM::Gateway#adapter Ne
A
ROM::Memory::Gateway Ne
A
ROM::Relation#schema Ne
A
ROM::Gateway#logger Ne
A
ROM::Schema#prefix Ne
A
ROM::Schema#rename Ne
A
ROM::Lint::Gateway Ne
A
ROM::Lint::Linter Ne
A
ROM::Relation#new Ne
A
ROM::Environment Ne
A
ROM::Schema#wrap Ne
A
ROM::Schema#to_h Ne
A
ROM::Lint::Test Ne
A
ROM::Container Ne
A
ROM::Relation Ne
A
ROM::Global Ne
A
ROM::Lint::Gateway#initialize Ne
A
ROM::Lint::Gateway#lint_transaction_support Ne
A
ROM::Lint::Gateway#lint_dataset_predicate Ne
A
ROM::Lint::EnumerableDataset#lint_each Ne
A
ROM::Lint::Gateway#lint_dataset_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::Schema::Attribute#type Ne
A
ROM::Commands::Result#error Ne
A
ROM::Lint::Linter.each_lint Ne
A
ROM::Commands::Result#value Ne
A
ROM::Lint::Gateway#gateway Ne
A
ROM::Gateway#disconnect Ne
A
ROM::Lint::Gateway#uri Ne
A
ROM::Relation#[] Ne
A
ROM::Relation::Curried#call Ne
A
ROM::Relation::Materializable#one E
A
ROM::Relation::Loaded#one E
A
ROM::Gateway#use_logger E
A
ROM::Lint::Linter#lint E
A
ROM::ArrayDataset E
A
ROM::Schema#[] E
A
ROM::Gateway E
A
ROM::Relation#each E
A
ROM::Commands::Lazy#>> E
A
ROM::Commands::Result::Failure#to_ary E
A
ROM::Commands::Result::Success#to_ary E
A
ROM::Memory::Gateway#use_logger E
A
ROM::Memory::Gateway#logger E
A
ROM::PluginRegistryBase#[] 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.