- Inch CI - Documentation badges for Ruby, JS & Elixir projects

#56 (all)

Elixir (change)

8 seconds

almost 6 years ago

Build History Evaluation Suggestions 20+ 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	Ecto.Repo
A	Ecto.Adapter.TestTransactions
A	Mix.Tasks.Ecto.Gen.Migration
A	Ecto.Associations.BelongsTo
A	Ecto.Adapter.Transactions
Show 29 more ...

Proper documentation present
B	Ecto.Validator.Predicates.between/4
B	Ecto.Changeset.fetch_change/2
B	Ecto.Changeset.get_change/3
B	Ecto.Changeset.validate_change/3
B	Ecto.Changeset.update_change/3
Show 35 more ...

Please take a look
–

Undocumented
U	Ecto.DateTime.from_erl/1
U	Ecto.Time.from_erl/1
U	Ecto.Date.from_erl/1
U	Ecto.DateTime.from_date_time/2
U	Inspect.Ecto.Query.to_string/1
Show 14 more ...

Everything Inch CI

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

This page is for 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!

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

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

Can I have my own badges?

What is the goal of this?