# Inch CI

rom-rb/rom-elasticsearch Rom elasticsearch

Elasticsearch adapter for rom

Refresh
#3 (all)
Ruby (change)
6 seconds
9 months ago
Build History Evaluation Suggestions 12   Read the docs

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::Elasticsearch::Gateway#dataset N
A
ROM::Elasticsearch::Plugins::Relation::QueryDSL::InstanceMethods#search Ne
A
ROM::Elasticsearch::Plugins::Relation::QueryDSL Ne
A
ROM::Elasticsearch::Relation#delete_index Ne
A
ROM::Elasticsearch::Relation#create_index Ne
Show 37 more ...
Proper documentation present
B
ROM::Elasticsearch::Relation#query_string Ne
B
ROM::Elasticsearch::Types.Keyword Ne
B
ROM::Elasticsearch::Relation#get Ne
B
ROM::Elasticsearch::Types.Text Ne
Please take a look
–
Undocumented
U
ROM::Elasticsearch::Plugins::Relation::QueryDSL::Builder#initialize Ne
U
ROM::Elasticsearch::Plugins::Relation::QueryDSL::Builder#relation Ne
U
ROM::Elasticsearch::Plugins::Relation::QueryDSL::InstanceMethods Ne
U
ROM::Elasticsearch::Plugins::Relation::QueryDSL::Builder Ne
U
ROM::Elasticsearch::Gateway#client Ne
Show 3 more ...
Everything Inch CI

Let's raise the visibility of documentation in Open Source!

This page is for rom-rb/rom-elasticsearch 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.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.

Sign in with GitHub | Contact | Imprint | Data privacy | Blog