rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#904 (all)
Ruby (change)
14 seconds
over 4 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.

Seems really good
A
ROM::Global#setup N
A
ROM::Gateway.setup N
A
ROM N
A
ROM::Commands::Result#to_ary Ne
A
ROM::Commands::Graph#call Ne
A
ROM::Options#initialize Ne
A
ROM::Env#relation Ne
A
ROM::Setup 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::Lint::TestRepository#repository Ne
A
ROM::Lint::TestGateway#identifier Ne
A
ROM::Gateway#extend_command_class Ne
A
ROM::Lint::TestEnumerableDataset Ne
A
ROM::Commands::Result::Failure Ne
A
ROM::Commands::Result::Success Ne
A
ROM::Lint::TestGateway#gateway Ne
A
ROM::Memory::Commands::Delete Ne
A
ROM::Memory::Commands::Create Ne
A
ROM::Memory::Commands::Update Ne
A
ROM::EnumerableDataset#to_ary Ne
A
ROM::Lint::EnumerableDataset Ne
A
ROM::Lint::TestGateway#uri Ne
A
ROM::CommandRegistry#try Ne
A
ROM::Commands::Composite Ne
A
ROM::CommandRegistry#as Ne
A
ROM::Gateway#connection Ne
A
ROM::CommandRegistry#[] Ne
A
ROM::Lint::TestGateway Ne
A
ROM::EnumerableDataset Ne
A
ROM::Memory::Relation Ne
A
ROM::Commands::Result Ne
A
ROM::CommandRegistry Ne
A
ROM::Memory::Dataset Ne
A
ROM::Options#options Ne
A
ROM::Memory::Gateway Ne
A
ROM::Global#finalize Ne
A
ROM::Setup#finalize Ne
A
ROM::Lint::Gateway Ne
A
ROM::Env#relations Ne
A
ROM::Env#commands Ne
A
ROM::Env#gateways Ne
A
ROM::Lint::Linter Ne
A
ROM::Env#command Ne
A
ROM::Pipeline#>> Ne
A
ROM::Env#mappers Ne
A
ROM::Lint::Test Ne
A
ROM::Repository Ne
A
ROM::Global#env Ne
A
ROM::Processor Ne
A
ROM::Options Ne
A
ROM::Gateway Ne
A
ROM::Global Ne
A
ROM::Env Ne
A
ROM::Lint::Gateway#initialize 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::Commands::Result#error Ne
A
ROM::Commands::Result#value Ne
A
ROM::Lint::Linter.each_lint Ne
A
ROM::Lint::Gateway#gateway Ne
A
ROM::Gateway#disconnect Ne
A
ROM::Gateway#use_logger Ne
A
ROM::Lint::Gateway#uri Ne
A
ROM::Gateway#logger Ne
A
ROM::Options::ClassMethods#option E
A
ROM::Lint::TestRepository E
A
ROM::Lint::Linter#lint E
A
ROM::Commands::Delete E
A
ROM::Commands::Update E
A
ROM::ArrayDataset E
A
ROM::Commands::Result::Failure#to_ary E
A
ROM::Commands::Result::Success#to_ary E
A
ROM::AdapterPluginRegistry#[] E
A
ROM::Commands::Delete#target E
A
ROM::Memory::Gateway#logger E
A
ROM::Memory::Gateway#use_logger 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.