# Inch CI

troessner/reek Reek

Code smell detector for Ruby

Refresh
#190 (all)
Ruby (change)
67 seconds
almost 2 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
Reek::Spec::ShouldReekOf N
A
Reek::CLI::Options N
A
Reek::Examiner#initialize N
A
Reek::CodeComment::CodeCommentValidator Ne
A
Reek::SmellDetectors::BaseDetector Ne
Show 264 more ...
Proper documentation present
B
Reek::CodeComment::CodeCommentValidator#initialize N
B
Reek::Report::BaseReport#initialize N
B
Reek::SmellWarning#initialize Ne
B
Reek::AST::Node#each_node Ne
B
Reek::Source::SourceCode#initialize Ne
B
Reek::SmellConfiguration#value Ne
B
Reek::Spec#reek_only_of Ne
B
Reek::Configuration::ConfigurationFileFinder.find_and_load Ne
B
Reek::Configuration::ConfigurationFileFinder.find Ne
B
Reek::Source::SourceLocator#initialize Ne
B
Reek::Report::Formatter::SimpleWarningFormatter#format_code_climate_hash Ne
B
Reek::Report::Formatter::SimpleWarningFormatter#format_hash Ne
B
Reek::SmellDetectors::Syntax#smells_from_source Ne
B
Reek::Context::CodeContext#record_call_to Ne
B
Reek::Configuration::ExcludedPaths#add Ne
B
Reek::AST::Builder#string_value Ne
B
Reek::Rake::Task#fail_on_error= Ne
B
Reek::AST::Node#look_for_types Ne
B
Reek::Rake::Task#config_file= Ne
B
Reek::CodeComment#initialize Ne
B
Reek::Overrides#for_context Ne
B
Reek::Rake::Task#reek_opts= Ne
B
Reek::Rake::Task#verbose= Ne
B
Reek::Rake::Task#name= Ne
B
Reek::Spec#reek Ne
B
Reek::AST::Node#look_for_type E
B
Reek::Report::TextReport#initialize E
B
Reek::ContextBuilder#process_ivar E
B
Reek::ContextBuilder#process_begin E
B
Reek::Report::Formatter::WikiLinkWarningFormatter#format_hash E
B
Reek::ContextBuilder#process_module E
B
Reek::ContextBuilder#process_while E
Please take a look
C
Reek::SmellDetectors::UnusedPrivateMethod#sniff Ne
C
Reek::Context::ModuleContext#node_instance_methods E
C
Reek::Rake::Task#initialize E
Undocumented
U
Reek::Errors::GarbageDetectorConfigurationInCommentError#initialize N
U
Reek::Errors::BadDetectorConfigurationKeyInCommentError#initialize N
U
Reek::Errors::BadDetectorInCommentError#initialize N
U
Reek::SmellWarning#to_hash N
U
Reek::Report Ne
Show 261 more ...
Everything Inch CI

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

This page is for troessner/reek 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