rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#97 (all)
Ruby (change)
43 seconds
almost 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
Undocumented
U
ROM N
U
ROM::Adapter::Memory::Dataset#to_ary N
U
ROM::Commands::Delete#new N
U
ROM::Commands::Update#new N
U
ROM::CommandRegistry#try N
U
ROM::Result#to_ary N
U
ROM::CommandDSL::CommandDefinition#initialize Ne
U
ROM::Adapter::Memory::Dataset#restrict Ne
U
ROM::Adapter::Memory::Dataset#project Ne
U
ROM::Adapter::Memory::Dataset#order Ne
U
ROM::Boot::SchemaDSL#base_relation Ne
U
ROM::Adapter::Memory::Dataset#each 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::Boot::DSL#mappers Ne
U
ROM::CommandDSL#define Ne
U
ROM::Result::Success#> Ne
U
ROM::Boot::DSL#schema Ne
U
ROM::MapperDSL#define Ne
U
ROM::Boot#commands Ne
U
ROM::CommandDSL::CommandDefinition#validator Ne
U
ROM::CommandDSL::CommandDefinition#options Ne
U
ROM::CommandDSL::CommandDefinition#result Ne
U
ROM::CommandDSL::CommandDefinition#input Ne
U
ROM::CommandDSL::CommandDefinition#type Ne
U
ROM::CommandDSL::CommandDefinition#to_h Ne
U
ROM::Boot::BaseRelationDSL#repositories Ne
U
ROM::Adapter::Memory::Commands::Create Ne
U
ROM::Adapter::Memory::Commands::Update Ne
U
ROM::Adapter::Memory::Commands::Delete Ne
U
ROM::Commands::WithOptions#initialize Ne
U
ROM::Boot::BaseRelationDSL#initialize Ne
U
ROM::Boot::BaseRelationDSL#attributes Ne
U
ROM::Adapter#extend_relation_instance Ne
U
ROM::Boot::BaseRelationDSL#repository Ne
U
ROM::Commands::WithOptions#validator Ne
U
ROM::Adapter::Memory::Dataset#delete Ne
U
ROM::Adapter::Memory::Dataset#header Ne
U
ROM::Adapter::Memory::Dataset#insert Ne
U
ROM::Boot::BaseRelationDSL#attribute Ne
U
ROM::Commands::WithOptions#relation Ne
U
ROM::Boot::BaseRelationDSL#datasets Ne
U
ROM::Adapter::Memory::Storage#data Ne
U
ROM::Adapter#extend_relation_class Ne
U
ROM::CommandDSL::CommandDefinition Ne
U
ROM::Commands::WithOptions#options Ne
U
ROM::Boot::RelationDSL#initialize Ne
U
ROM::Commands::WithOptions#result Ne
U
ROM::Commands::WithOptions#input Ne
U
ROM::Boot::RelationDSL#relations Ne
U
ROM::Adapter::Memory::Storage#[] Ne
U
ROM::CommandRegistry::Evaluator Ne
U
ROM::Boot::BaseRelationDSL#name Ne
U
ROM::Result::Failure#initialize Ne
U
ROM::Result::Success#initialize Ne
U
ROM::Commands::WithOptions#call Ne
U
ROM::Boot::SchemaDSL#initialize Ne
U
ROM::Adapter#command_namespace Ne
U
ROM::Boot::BaseRelationDSL#env Ne
U
ROM::Boot#adapter_relation_map Ne
U
ROM::Commands::Update#execute Ne
U
ROM::Adapter::Memory::Dataset Ne
U
ROM::Commands::Delete#execute Ne
U
ROM::Boot::RelationDSL#schema Ne
U
ROM::Adapter::Memory::Storage Ne
U
ROM::Commands::Create#execute Ne
U
ROM::Adapter::Memory.schemes Ne
U
ROM::Adapter::Memory#logger= Ne
U
ROM::Boot::RelationDSL#call Ne
U
ROM::Result::Success#to_ary Ne
U
ROM::Adapter::Memory#logger Ne
U
ROM::Boot::SchemaDSL#schema Ne
U
ROM::Commands::Delete.build Ne
U
ROM::Commands::Delete#call Ne
U
ROM::Boot::BaseRelationDSL Ne
U
ROM::Boot::DSL#initialize Ne
U
ROM::Commands::Update#set Ne
U
ROM::Boot::SchemaDSL#call Ne
U
ROM::CommandDSL#commands Ne
U
ROM::Boot::SchemaDSL#env Ne
U
ROM::Adapter#connection Ne
U
ROM::Adapter#initialize Ne
U
ROM::Adapter::Memory#[] Ne
U
ROM::Boot#repositories Ne
U
ROM::MapperDSL#mappers Ne
U
ROM::Boot::RelationDSL Ne
U
ROM::Commands::Create Ne
U
ROM::Env#repositories Ne
U
ROM::Commands::Update Ne
U
ROM::Adapter.register Ne
U
ROM::Commands::Delete Ne
U
ROM::Adapter::Memory Ne
U
ROM::CommandRegistry Ne
U
ROM::Reader#relation Ne
U
ROM::Boot::SchemaDSL Ne
U
ROM::CommandDSL#call Ne
U
ROM::Adapter#command Ne
U
ROM::Result::Failure Ne
U
ROM::Result::Success Ne
U
ROM::Relation#header Ne
U
ROM::Adapter#schema Ne
U
ROM::MapperDSL#call Ne
U
ROM::Reader#mappers Ne
U
ROM::Reader#mapper Ne
U
ROM::Boot::DSL#env Ne
U
ROM::Adapter.setup Ne
U
ROM::Env#relations Ne
U
ROM::Reader#header Ne
U
ROM::Result#error Ne
U
ROM::Env#commands Ne
U
ROM::Result#value Ne
U
ROM::Env#command Ne
U
ROM::Reader#path Ne
U
ROM::Env#mappers Ne
U
ROM::Adapter#uri Ne
U
ROM::CommandDSL Ne
U
ROM::Adapter.[] Ne
U
ROM::Env#schema Ne
U
ROM::Boot::DSL Ne
U
ROM::MapperDSL Ne
U
ROM::Boot#env Ne
U
ROM::Adapter Ne
U
ROM::Result Ne
U
ROM::Adapter::Memory#initialize E
U
ROM::Adapter::Memory::Commands::Create#execute E
U
ROM::Adapter::Memory::Commands::Update#execute E
U
ROM::CommandRegistry::Evaluator#method_missing E
U
ROM::Adapter::Memory::Commands::Delete#execute E
U
ROM::Adapter::Memory#connection 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.