rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#222 (all)
Ruby (change)
12 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.

Please take a look
Undocumented
U
ROM N
U
ROM::CommandDSL::CommandDefinition#method_missing N
U
ROM::Adapter::Memory::Dataset#to_ary N
U
ROM::CommandRegistry#try N
U
ROM::Result#to_ary N
U
ROM::Reader.build N
U
ROM.relation N
U
ROM.commands N
U
ROM.mappers N
U
ROM::CommandDSL::CommandDefinition#initialize Ne
U
ROM::Adapter::Memory::Dataset#project Ne
U
ROM::Adapter::Memory::Dataset#order Ne
U
ROM::Adapter::Memory::Dataset#join Ne
U
ROM::Adapter::Memory::Dataset#each Ne
U
ROM::Boot::SchemaDSL#base_relation Ne
U
ROM::Boot::RelationDSL#register Ne
U
ROM::Boot::BaseRelationDSL#call Ne
U
ROM::Boot::DSL#commands Ne
U
ROM::Result::Failure#> Ne
U
ROM::Result::Success#> Ne
U
ROM::Boot::DSL#mappers Ne
U
ROM::CommandDSL#define Ne
U
ROM::MapperDSL#define Ne
U
ROM::Boot::DSL#schema Ne
U
ROM::Boot#commands Ne
U
ROM.schema Ne
U
ROM::Adapter::Memory::Storage#create_dataset Ne
U
ROM::CommandDSL::CommandDefinition#options Ne
U
ROM::Adapter::Memory::Dataset#initialize Ne
U
ROM::CommandDSL::CommandDefinition#to_h Ne
U
ROM::CommandDSL::CommandDefinition#type Ne
U
ROM::Commands::AbstractCommand#relation Ne
U
ROM::Adapter::Memory::Commands::Update Ne
U
ROM::Processor::Transproc#to_transproc Ne
U
ROM::Commands::AbstractCommand#options Ne
U
ROM::Adapter::Memory::Commands::Delete Ne
U
ROM::Adapter::Memory::Commands::Create Ne
U
ROM::Adapter::Memory::Dataset#restrict Ne
U
ROM::Boot::BaseRelationDSL#initialize Ne
U
ROM::Commands::AbstractCommand#result Ne
U
ROM::Boot::BaseRelationDSL#repository Ne
U
ROM::Commands::WithOptions#validator Ne
U
ROM::Boot::BaseRelationDSL#attribute Ne
U
ROM::Adapter::Memory::Dataset#insert Ne
U
ROM::Processor::Transproc#tuple_proc Ne
U
ROM::Adapter::Memory::Dataset#header Ne
U
ROM::Processor::Transproc#initialize Ne
U
ROM::Adapter::Memory::Dataset#delete Ne
U
ROM::Adapter::Memory::Storage#data Ne
U
ROM::CommandDSL::CommandDefinition Ne
U
ROM::Boot::RelationDSL#initialize Ne
U
ROM::Boot::BaseRelationDSL#header Ne
U
ROM::Processor::Transproc#mapping Ne
U
ROM::Processor::Transproc#header Ne
U
ROM::Adapter::Memory::Storage#[] Ne
U
ROM::Boot::RelationDSL#relations Ne
U
ROM::Commands::WithOptions#input Ne
U
ROM::CommandRegistry::Evaluator Ne
U
ROM::Result::Failure#initialize Ne
U
ROM::Processor::Transproc#model Ne
U
ROM::Boot::SchemaDSL#initialize Ne
U
ROM::Result::Success#initialize Ne
U
ROM::Boot::BaseRelationDSL#name Ne
U
ROM::Relation.relation_methods= Ne
U
ROM::Relation.relation_methods Ne
U
ROM::Boot#adapter_relation_map Ne
U
ROM::Commands::AbstractCommand Ne
U
ROM::Boot::BaseRelationDSL#env Ne
U
ROM::Adapter::Memory::Dataset Ne
U
ROM::Adapter::Memory::Storage Ne
U
ROM::Boot::RelationDSL#schema Ne
U
ROM::Adapter::Memory.schemes Ne
U
ROM::Adapter::Memory#logger= Ne
U
ROM::Adapter::Memory#dataset Ne
U
ROM::Boot::RelationDSL#call Ne
U
ROM::Adapter::Memory#logger Ne
U
ROM::Result::Success#to_ary Ne
U
ROM::Boot::SchemaDSL#schema Ne
U
ROM::Boot::BaseRelationDSL Ne
U
ROM::Processor::Transproc Ne
U
ROM::Boot::SchemaDSL#call Ne
U
ROM::Boot::DSL#initialize Ne
U
ROM::Commands::Update#set Ne
U
ROM::CommandDSL#commands Ne
U
ROM::Boot::SchemaDSL#env Ne
U
ROM::Config.config_hash Ne
U
ROM::Adapter::Memory#[] Ne
U
ROM::Boot::RelationDSL Ne
U
ROM::MapperDSL#mappers Ne
U
ROM::Boot#repositories Ne
U
ROM::Env#repositories Ne
U
ROM::Result::Failure Ne
U
ROM::Boot::SchemaDSL Ne
U
ROM::Processor.build Ne
U
ROM::Result::Success Ne
U
ROM::CommandDSL#call Ne
U
ROM::CommandRegistry Ne
U
ROM::Reader#relation Ne
U
ROM::Adapter::Memory Ne
U
ROM::Reader#mappers Ne
U
ROM::MapperDSL#call Ne
U
ROM::Env#relations Ne
U
ROM::Reader#mapper Ne
U
ROM::Boot::DSL#env Ne
U
ROM::Config.build Ne
U
ROM::Result#error Ne
U
ROM::Result#value Ne
U
ROM::Env#commands Ne
U
ROM::Reader#path Ne
U
ROM::Env#mappers Ne
U
ROM::CommandDSL Ne
U
ROM::Env#schema Ne
U
ROM::Processor Ne
U
ROM::Boot::DSL Ne
U
ROM::MapperDSL Ne
U
ROM::Boot#env Ne
U
ROM.finalize Ne
U
ROM::Result Ne
U
ROM::Config Ne
U
ROM.env Ne
U
ROM::Adapter::Memory#initialize E
U
ROM::CommandRegistry::Evaluator#method_missing E
U
ROM::Commands::Delete#initialize E
U
ROM::Processor::Transproc.build E
U
ROM::Result::Failure#to_ary 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.