rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#557 (all)
Ruby (change)
10 seconds
over 5 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.

Please take a look
C
ROM::Global#relation Ne
C
ROM::Reader.build Ne
Undocumented
U
ROM::Repository#extend_command_class N
U
ROM::Memory::Relation#insert N
U
ROM::Command.build_class N
U
ROM::Memory::Dataset#insert N
U
ROM::Global#commands N
U
ROM::Global#mappers N
U
ROM N
U
ROM::Lint::Test#define_test_method Ne
U
ROM::Setup::CommandDSL#initialize Ne
U
ROM::Setup::MapperDSL#initialize Ne
U
ROM::Setup::CommandDSL#define Ne
U
ROM::Setup::MapperDSL#define Ne
U
ROM::Memory::Dataset#project Ne
U
ROM::Memory::Relation#delete Ne
U
ROM::Memory::Dataset#order Ne
U
ROM::Memory::Dataset#join Ne
U
ROM::ClassMacros#defines Ne
U
ROM::Relation.forward Ne
U
ROM::Repository.setup Ne
U
ROM::Adapter::Lint::TestRepository#test_dataset_predicate Ne
U
ROM::Adapter::Lint::TestRepository#test_dataset_reader Ne
U
ROM::Adapter::Lint::TestRepository#repository_instance Ne
U
ROM::Adapter::Lint::TestEnumerableDataset#test_to_a Ne
U
ROM::Adapter::Lint::TestEnumerableDataset#test_each Ne
U
ROM::Adapter::Lint::TestEnumerableDataset#dataset Ne
U
ROM::Adapter::Lint::TestEnumerableDataset#data Ne
U
ROM::Adapter::Lint::TestRepository#test_setup Ne
U
ROM::Lint::Repository#lint_dataset_predicate Ne
U
ROM::Lint::Repository#lint_repository_setup Ne
U
ROM::Lint::Repository#lint_dataset_reader Ne
U
ROM::Lint::Repository#repository_instance Ne
U
ROM::Memory::Repository#command_namespace Ne
U
ROM::Lint::TestEnumerableDataset#dataset Ne
U
ROM::Lint::EnumerableDataset#initialize Ne
U
ROM::Lint::EnumerableDataset#lint_each Ne
U
ROM::Processor::Transproc#to_transproc Ne
U
ROM::Lint::EnumerableDataset#lint_to_a Ne
U
ROM::Lint::TestEnumerableDataset#data Ne
U
ROM::Lint::TestRepository#identifier Ne
U
ROM::Lint::TestRepository#repository Ne
U
ROM::Processor::Transproc#initialize Ne
U
ROM::Lint::EnumerableDataset#dataset Ne
U
ROM::Memory::Storage#create_dataset Ne
U
ROM::Processor::Transproc#row_proc Ne
U
ROM::Processor::Transproc#mapping Ne
U
ROM::Lint::EnumerableDataset#data Ne
U
ROM::Lint::Repository#initialize Ne
U
ROM::Command.generate_class_name Ne
U
ROM::Processor::Transproc#header Ne
U
ROM::Lint::Repository#identifier Ne
U
ROM::Lint::Repository#repository Ne
U
ROM::Commands::Abstract#relation Ne
U
ROM::Processor::Transproc#model Ne
U
ROM::Setup::CommandDSL#relation Ne
U
ROM::Memory::Repository#dataset Ne
U
ROM::Command.adapter_namespace Ne
U
ROM::Setup::CommandDSL#adapter Ne
U
ROM::Memory::Commands::Create Ne
U
ROM::Memory::Commands::Delete Ne
U
ROM::EnumerableDataset#to_ary Ne
U
ROM::Memory::Commands::Update Ne
U
ROM::Memory::Dataset#restrict Ne
U
ROM::Lint::TestRepository#uri Ne
U
ROM::Setup::MapperDSL#mappers Ne
U
ROM::Lint::EnumerableDataset Ne
U
ROM::Memory::Dataset#delete Ne
U
ROM::Lint::Linter.each_lint Ne
U
ROM::Memory::Repository#[] Ne
U
ROM::Relation#__registry__ Ne
U
ROM::Repository#use_logger Ne
U
ROM::Relation.default_name Ne
U
ROM::Memory::Storage#size Ne
U
ROM::Memory::Storage#data Ne
U
ROM::Processor::Transproc Ne
U
ROM::Lint::Repository#uri Ne
U
ROM::Command.default_name Ne
U
ROM::Commands::Abstract Ne
U
ROM::Memory::Repository Ne
U
ROM::Lint::Linter.lints Ne
U
ROM::Memory::Storage#[] Ne
U
ROM::Repository#logger Ne
U
ROM::ClassBuilder#call Ne
U
ROM::Relation.registry Ne
U
ROM::Lint::Linter#lint Ne
U
ROM::Setup::CommandDSL Ne
U
ROM::Memory::Relation Ne
U
ROM::Command.registry Ne
U
ROM::Relation#dataset Ne
U
ROM::Lint::Repository Ne
U
ROM::Setup::MapperDSL Ne
U
ROM::Env#repositories Ne
U
ROM::Memory::Storage Ne
U
ROM::Memory::Dataset Ne
U
ROM::Command.options Ne
U
ROM::Global#finalize Ne
U
ROM::Reader#to_ary Ne
U
ROM::Command.build Ne
U
ROM::Env#relations Ne
U
ROM::Relation#name Ne
U
ROM::Env#commands Ne
U
ROM::Lint::Linter Ne
U
ROM::ClassBuilder Ne
U
ROM::Env#readers Ne
U
ROM::Relation.[] Ne
U
ROM::ClassMacros Ne
U
ROM::Global#env Ne
U
ROM::Lint::Test Ne
U
ROM::Command.[] Ne
U
ROM::Command Ne
U
ROM::Memory::Repository#use_logger E
U
ROM::Memory::Repository#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.