michaelherold/codeclimate-haml_lint Codeclimate haml lint

#19 (all)
Ruby (change)
18 seconds
over 3 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.

Seems really good
A
CC::Engine::SourceFile#initialize N
A
CC::Engine::Issue#initialize N
A
CC::Engine::RemediationPoints#to_json Ne
A
CC::Engine::HamlLint#initialize Ne
A
CC::Engine::Categories#to_json Ne
A
CC::Engine::Location#to_json Ne
A
CC::Engine::Content#to_json Ne
A
CC::Engine::Configuration#to_linter_config Ne
A
CC::Engine::RemediationPoints#initialize Ne
A
CC::Engine::Configuration#include_paths Ne
A
CC::Engine::Configuration#exclude_paths Ne
A
CC::Engine::ReportAdapter#initialize Ne
A
CC::Engine::Configuration#initialize Ne
A
CC::Engine::RemediationPoints#points Ne
A
CC::Engine::Configuration.from_file Ne
A
CC::Engine::Severity.from_haml_lint Ne
A
CC::Engine::Location.from_haml_lint Ne
A
CC::Engine::Fingerprint#initialize Ne
A
CC::Engine::Categories#initialize Ne
A
CC::Engine::Configuration#config Ne
A
CC::Engine::Configuration#checks Ne
A
CC::Engine::Location#initialize Ne
A
CC::Engine::FileList#initialize Ne
A
CC::Engine::Content#initialize Ne
A
CC::Engine::SourceFile#process Ne
A
CC::Engine::Issue#fingerprint Ne
A
CC::Engine::RemediationPoints Ne
A
CC::Engine::Issue#description Ne
A
CC::Engine::Categories#linter Ne
A
CC::Engine::Fingerprint#to_s Ne
A
CC::Engine::Issue#categories Ne
A
CC::Engine::Issue#check_name Ne
A
CC::Engine::SourceFile#path Ne
A
CC::Engine::Content#linter Ne
A
CC::Engine::Issue#location Ne
A
CC::Engine::Issue#severity Ne
A
CC::Engine::Configuration Ne
A
CC::Engine::Issue#to_json Ne
A
CC::Engine::Issue#content Ne
A
CC::Engine::Location#to_h Ne
A
CC::Engine::ReportAdapter Ne
A
CC::Engine::Location#path Ne
A
CC::Engine::Location#line Ne
A
CC::Engine::Issue#points Ne
A
CC::Engine::Content#body Ne
A
CC::Engine::Content#to_h Ne
A
CC::Engine::HamlLint#run Ne
A
CC::Engine::Fingerprint Ne
A
CC::Engine::Issue#to_h Ne
A
CC::Engine::Issue#type Ne
A
CC::Engine::Categories Ne
A
CC::Engine::SourceFile Ne
A
CC::Engine::Severity Ne
A
CC::Engine::Location Ne
A
CC::Engine::FileList Ne
A
CC::Engine::HamlLint Ne
A
CC::Engine::Content Ne
A
CC::Engine::Issue Ne
A
CC::Engine::ReportAdapter#each E
A
CC::Engine::FileList#each E
A
CC E
Proper documentation present
Please take a look
Undocumented

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

This page is for michaelherold/codeclimate-haml_lint 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.