troessner/reek
Code smell detector for Ruby – Read the documentation
This page shows an evaluation of the documentation of troessner/reek.
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
|
String |
|
|
A
|
File |
|
|
A
|
IO |
|
|
A
|
Reek::Rake::Task |
|
|
A
|
Reek::Core::CodeParser |
|
| Show 90 more ... | ||
|
A
|
Reek::SmellWarning |
|
|
A
|
Reek |
|
|
A
|
Reek:: … ::ControlParameterCollector |
|
|
A
|
Reek::Smells::ControlParameter::FoundControlParameter |
|
|
A
|
Reek::Smells::DuplicateMethodCall::CallCollector |
|
|
A
|
Reek::Smells::DuplicateMethodCall::FoundCall |
|
|
A
|
Reek::Smells::UncommunicativeParameterName |
|
|
A
|
Reek::Smells::UncommunicativeVariableName |
|
|
A
|
Reek::Smells::UncommunicativeMethodName |
|
|
A
|
Reek::Smells::UncommunicativeModuleName |
|
|
A
|
Reek::Core::WarningCollector#initialize |
|
|
A
|
Reek::Smells::NilCheck::CallNodeFinder |
|
|
A
|
Reek::Smells::TooManyInstanceVariables |
|
|
A
|
Reek::Smells::NilCheck::CaseNodeFinder |
|
|
A
|
Reek::Smells::NilCheck::NodeFinder |
|
|
A
|
Reek::Core::StopContext#initialize |
|
|
A
|
Reek::Core::SingletonMethodContext |
|
|
A
|
Reek::Smells::DuplicateMethodCall |
|
|
A
|
Reek::Smells::IrresponsibleModule |
|
|
A
|
Reek::Smells::RepeatedConditional |
|
|
A
|
Reek::Smells::TooManyStatements |
|
|
A
|
Reek::Smells::LongParameterList |
|
|
A
|
Reek::Smells::UnusedParameters |
|
|
A
|
Reek::Smells::PrimaDonnaMethod |
|
|
A
|
Reek::Smells::ControlParameter |
|
|
A
|
Reek::Core::SmellConfiguration |
|
|
A
|
Reek::Smells::BooleanParameter |
|
|
A
|
Reek::Smells::UtilityFunction |
|
|
A
|
Reek::Smells::NestedIterators |
|
|
A
|
Reek::Core::MethodParameters |
|
|
A
|
Reek::Core::WarningCollector |
|
|
A
|
Reek::Smells::TooManyMethods |
|
|
A
|
Reek::Core::SmellRepository |
|
|
A
|
Reek::SmellWarning#location |
|
|
A
|
Reek::Examiner#smells_count |
|
|
A
|
Reek::Smells::SmellDetector |
|
|
A
|
Reek::Smells::ClassVariable |
|
|
A
|
Reek::Smells::LongYieldList |
|
|
A
|
Reek::Smells::FeatureEnvy |
|
|
A
|
Reek::Core::MethodContext |
|
|
A
|
Reek::SmellWarning#status |
|
|
A
|
Reek::Cli::VersionCommand |
|
|
A
|
Reek::Core::ModuleContext |
|
|
A
|
Reek::Cli::VerboseReport |
|
|
A
|
Reek::SmellWarning#smell |
|
|
A
|
Reek::Core::CodeContext |
|
|
A
|
Reek::Smells::DataClump |
|
|
A
|
Reek::Core::StopContext |
|
|
A
|
Reek::Smells::Attribute |
|
|
A
|
Reek::Cli::Application |
|
|
A
|
Reek::Cli::ReekCommand |
|
|
A
|
Reek::Smells::NilCheck |
|
|
A
|
Reek::Cli::HelpCommand |
|
|
A
|
Reek::Cli::QuietReport |
|
|
A
|
String#to_reek_source |
|
|
A
|
Reek::Core::Overrides |
|
|
A
|
Reek::Examiner#smells |
|
|
A
|
File#to_reek_source |
|
|
A
|
Reek::Core::Sniffer |
|
|
A
|
Reek::Cli::Options |
|
|
A
|
Reek::Cli::Report |
|
|
A
|
Reek::Spec#reek |
|
|
A
|
Reek::Examiner |
|
|
A
|
Reek::Spec |
|
|
A
|
Reek::Smells::SmellDetector#smells_found |
|
|
A
|
Reek::Rake::Task#fail_on_error= |
|
|
A
|
Reek::Rake::Task#config_files= |
|
|
A
|
Reek::Rake::Task#source_files= |
|
|
A
|
Reek::Rake::Task#fail_on_error |
|
|
A
|
Reek::Rake::Task#source_files |
|
|
A
|
Reek::Rake::Task#config_files |
|
|
A
|
Reek::Rake::Task#reek_opts= |
|
|
A
|
Reek::Examiner#description= |
|
|
A
|
Reek::Rake::Task#ruby_opts= |
|
|
A
|
Reek::Rake::Task#reek_opts |
|
|
A
|
Reek::Rake::Task#ruby_opts |
|
|
A
|
Reek::Examiner#description |
|
|
A
|
Reek::Rake::Task#verbose= |
|
|
A
|
Reek::Rake::Task#verbose |
|
|
A
|
Reek::Rake::Task#name= |
|
|
A
|
Reek::Rake::Task#libs= |
|
|
A
|
Reek::Rake::Task#name |
|
|
A
|
Reek::Rake::Task#libs |
|
|
A
|
Reek::Smells::DuplicateMethodCall#examine_context |
|
|
A
|
Reek::Smells::TooManyMethods#examine_context |
|
|
A
|
Reek::Examiner#all_active_smells |
|
|
A
|
Reek::Examiner#num_active_smells |
|
|
A
|
Reek::Examiner#num_masked_smells |
|
|
A
|
Reek::Examiner#all_smells |
|
|
A
|
Reek::Rake::Task#initialize |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Reek::Core::CodeParser#process_call |
|
|
B
|
Reek::Spec#reek_of |
|
|
B
|
Reek::Core::CodeContext#method_missing |
|
|
B
|
Reek::Spec#reek_only_of |
|
|
B
|
Reek::Core::SmellConfiguration#value |
|
| Show 24 more ... | ||
|
B
|
Reek:: … #examine_context |
|
|
B
|
Reek:: … #examine_context |
|
|
B
|
Reek::Smells::UncommunicativeModuleName#examine_context |
|
|
B
|
Reek::Smells::UncommunicativeMethodName#examine_context |
|
|
B
|
Reek::Smells::TooManyInstanceVariables#examine_context |
|
|
B
|
Reek::Smells::RepeatedConditional#examine_context |
|
|
B
|
Reek::Smells::IrresponsibleModule#examine_context |
|
|
B
|
Reek::Smells::TooManyStatements#examine_context |
|
|
B
|
Reek::Smells::LongParameterList#examine_context |
|
|
B
|
Reek::Smells::UnusedParameters#examine_context |
|
|
B
|
Reek::Smells::ControlParameter#examine_context |
|
|
B
|
Reek::Smells::BooleanParameter#examine_context |
|
|
B
|
Reek::Smells::UtilityFunction#examine_context |
|
|
B
|
Reek::Smells::NestedIterators#examine_context |
|
|
B
|
Reek::Smells::LongYieldList#examine_context |
|
|
B
|
Reek::Smells::ClassVariable#examine_context |
|
|
B
|
Reek::Smells::FeatureEnvy#examine_context |
|
|
B
|
Reek::Smells::Attribute#examine_context |
|
|
B
|
Reek::Smells::DataClump#examine_context |
|
|
B
|
IO#to_reek_source |
|
|
B
|
Reek::Smells::RepeatedConditional#conditional_counts |
|
|
B
|
Reek::Smells::ClassVariable#class_variables_in |
|
|
B
|
Reek::Core::CodeParser#process_iter |
|
|
B
|
Reek::Core::Overrides#for_context |
|
| Needs work | ||
|---|---|---|
|
C
|
Reek::Examiner#initialize |
|
| Undocumented | ||
|---|---|---|
|
U
|
Reek::Core::SmellConfiguration#merge! |
|
|
U
|
Reek::Core::CodeParser#process_self |
|
|
U
|
Reek::Core::CodeParser#process_module |
|
|
U
|
Reek::Core::CodeParser#process_while |
|
|
U
|
Reek::Core::CodeParser#process_ivar |
|
| Show 153 more ... | ||
|
U
|
Reek::SmellWarning#initialize |
|
|
U
|
Reek::Cli::Report#initialize |
|
|
U
|
Reek::Core::StopContext#method_missing |
|
|
U
|
Reek::Core::CodeContext#local_nodes |
|
|
U
|
Reek::Core::CodeParser#process_args |
|
|
U
|
Reek::Core::StopContext#config_for |
|
|
U
|
Reek::Core::CodeContext#each_node |
|
|
U
|
Reek:: … #control_parameters |
|
|
U
|
Reek:: … #find_block_argument_variable_names |
|
|
U
|
Reek:: … #recursively_record_variable_names |
|
|
U
|
Reek:: … #find_assignment_variable_names |
|
|
U
|
Reek:: … #initialize |
|
|
U
|
Reek:: … #smell_message |
|
|
U
|
Reek:: … #initialize |
|
|
U
|
Reek:: … #record_variable_name |
|
|
U
|
Reek:: … ::CallCollector#smelly_calls |
|
|
U
|
Reek:: … ::FoundControlParameter#record |
|
|
U
|
Reek:: … ::FoundControlParameter#lines |
|
|
U
|
Reek:: … ::CallCollector#initialize |
|
|
U
|
Reek:: … ::FoundControlParameter#name |
|
|
U
|
Reek:: … ::FoundCall#smell_message |
|
|
U
|
Reek:: … #variable_names |
|
|
U
|
Reek:: … ::CallCollector#context |
|
|
U
|
Reek::Smells::DuplicateMethodCall::FoundCall#initialize |
|
|
U
|
Reek::Smells::DuplicateMethodCall::CallCollector#calls |
|
|
U
|
Reek::Smells::DuplicateMethodCall::FoundCall#record |
|
|
U
|
Reek::Smells::DuplicateMethodCall::FoundCall#occurs |
|
|
U
|
Reek::Smells::DuplicateMethodCall::FoundCall#lines |
|
|
U
|
Reek::Cli::WarningFormatterWithLineNumbers.format |
|
|
U
|
Reek::Smells::DuplicateMethodCall::FoundCall#call |
|
|
U
|
Reek::Core::MethodParameters#default_assignments |
|
|
U
|
Reek::Smells::ExcludeInitialize.default_config |
|
|
U
|
Reek::Smells::PrimaDonnaMethod#examine_context |
|
|
U
|
Reek::Smells::NilCheck::CallNodeFinder#smelly |
|
|
U
|
Reek::Smells::NilCheck::NodeFinder#initialize |
|
|
U
|
Reek::Smells::NilCheck::CaseNodeFinder#smelly |
|
|
U
|
Reek::Core::CodeContext#node_instance_methods |
|
|
U
|
Reek::Cli::SingleLineWarningFormatter.format |
|
|
U
|
Reek::Core::SmellConfiguration#overrides_for |
|
|
U
|
Reek::Core::MethodContext#record_use_of_self |
|
|
U
|
Reek::Smells::SmellDetector.smell_class_name |
|
|
U
|
Reek::Core::MethodContext#envious_receivers |
|
|
U
|
Reek::Cli::WarningFormatterWithLineNumbers |
|
|
U
|
Reek::Core::MethodContext#count_statements |
|
|
U
|
Reek::Smells::SmellDetector#configure_with |
|
|
U
|
Reek::Smells::SmellDetector.default_config |
|
|
U
|
Reek::Core::SmellConfiguration#initialize |
|
|
U
|
Reek::Core::SmellRepository.smell_classes |
|
|
U
|
Reek::Core::WarningCollector#found_smell |
|
|
U
|
Reek::Core::StopContext#count_statements |
|
|
U
|
Reek::Core::MethodContext#num_statements |
|
|
U
|
Reek::Core::MethodContext#record_call_to |
|
|
U
|
Reek::Cli::SimpleWarningFormatter.format |
|
|
U
|
Reek::Cli::VerboseReport#gather_results |
|
|
U
|
Reek::Core::SmellRepository#initialize |
|
|
U
|
Reek::Core::CodeParser#process_resbody |
|
|
U
|
Reek::Smells::SmellDetector#initialize |
|
|
U
|
Reek::Smells::NilCheck#examine_context |
|
|
U
|
Reek::Smells::SmellDetector#config_for |
|
|
U
|
Reek::Cli::ReportFormatter.format_list |
|
|
U
|
Reek::Core::CodeParser#process_default |
|
|
U
|
Reek::Core::SmellRepository#report_on |
|
|
U
|
Reek::Cli::QuietReport#gather_results |
|
|
U
|
Reek::Core::CodeParser#process_rescue |
|
|
U
|
Reek::Smells::SmellDetector#report_on |
|
|
U
|
Reek::Cli::Application#report_success |
|
|
U
|
Reek::Cli::SingleLineWarningFormatter |
|
|
U
|
Reek::Core::WarningCollector#warnings |
|
|
U
|
Reek::Core::SmellRepository#configure |
|
|
U
|
Reek::Core::CodeParser#process_block |
|
|
U
|
Reek::Core::MethodContext#parameters |
|
|
U
|
Reek::Cli::VersionCommand#initialize |
|
|
U
|
Reek::Smells::SmellDetector#register |
|
|
U
|
Reek::Smells::SmellDetector.contexts |
|
|
U
|
Reek::Cli::Application#report_smells |
|
|
U
|
Reek::Core::CodeContext#num_methods |
|
|
U
|
Reek::Smells::SmellDetector#examine |
|
|
U
|
Reek::Core::SmellRepository#examine |
|
|
U
|
Reek::Core::CodeParser#process_defn |
|
|
U
|
Reek::Core::CodeParser#process_case |
|
|
U
|
Reek::Core::CodeParser#process_when |
|
|
U
|
Reek::Core::CodeParser#process_defs |
|
|
U
|
Reek::Core::CodeContext#config_for |
|
|
U
|
Reek::Core::CodeContext#initialize |
|
|
U
|
Reek::Core::CodeParser#process_for |
|
|
U
|
Reek::Cli::ReekCommand#initialize |
|
|
U
|
Reek::Smells::SmellDetector#value |
|
|
U
|
Reek::Cli::HelpCommand#initialize |
|
|
U
|
Reek::Cli::VersionCommand#execute |
|
|
U
|
Reek::Cli::Application#initialize |
|
|
U
|
Reek::Core::CodeParser#process_if |
|
|
U
|
Reek::Cli::SimpleWarningFormatter |
|
|
U
|
Reek::Core::StopContext#full_name |
|
|
U
|
Reek::Cli::ReportFormatter.header |
|
|
U
|
Reek::Core::CodeParser#initialize |
|
|
U
|
Reek::Core::CodeContext#full_name |
|
|
U
|
Reek::Core::Overrides#initialize |
|
|
U
|
Reek::Smells::ExcludeInitialize |
|
|
U
|
Reek::Cli::Report#add_examiner |
|
|
U
|
Reek::Cli::Application#execute |
|
|
U
|
Reek::Cli::Options#set_options |
|
|
U
|
Reek::Cli::ReekCommand#execute |
|
|
U
|
Reek::SmellWarning#smell_class |
|
|
U
|
Reek::Core::MethodContext#refs |
|
|
U
|
Reek::Core::Sniffer#initialize |
|
|
U
|
Reek::Core::CodeParser#process |
|
|
U
|
Reek::Cli::HelpCommand#execute |
|
|
U
|
Reek::Cli::Options#get_sources |
|
|
U
|
Reek::Core::Sniffer#configure |
|
|
U
|
Reek::Core::Sniffer#report_on |
|
|
U
|
Reek::Cli::Options#initialize |
|
|
U
|
Reek::Cli::Application#output |
|
|
U
|
Reek::Cli::ReekCommand.create |
|
|
U
|
Reek::SmellWarning#report_on |
|
|
U
|
Reek::Core::CodeContext#name |
|
|
U
|
Reek::SmellWarning#is_active |
|
|
U
|
Reek::Core::Sniffer#examine |
|
|
U
|
Reek::Core::CodeContext#exp |
|
|
U
|
Reek::SmellWarning#subclass |
|
|
U
|
Reek::SmellWarning#context |
|
|
U
|
Reek::Cli::ReportFormatter |
|
|
U
|
Reek::SmellWarning#message |
|
|
U
|
Reek::Cli::Options#banner |
|
|
U
|
Reek::SmellWarning#source |
|
|
U
|
Reek::SmellWarning#lines |
|
|
U
|
Reek::Cli::Options#parse |
|
|
U
|
Reek::SmellWarning#hash |
|
|
U
|
Reek::SmellWarning#<=> |
|
|
U
|
Reek::Cli::Report#show |
|
|
U
|
Reek::SmellWarning#sort_key |
|
|
U
|
Reek:: … ::UncommunicativeParameterName.default_config |
|
|
U
|
Reek:: … ::UncommunicativeVariableName.default_config |
|
|
U
|
Reek::Smells::UncommunicativeModuleName.default_config |
|
|
U
|
Reek::Smells::UncommunicativeMethodName.default_config |
|
|
U
|
Reek::Smells::TooManyInstanceVariables.default_config |
|
|
U
|
Reek::Core::SingletonMethodContext#envious_receivers |
|
|
U
|
Reek::Smells::NilCheck::CallNodeFinder#initialize |
|
|
U
|
Reek::Smells::NilCheck::CaseNodeFinder#initialize |
|
|
U
|
Reek::Smells::DuplicateMethodCall.default_config |
|
|
U
|
Reek::Smells::RepeatedConditional.default_config |
|
|
U
|
Reek::Smells::LongParameterList.default_config |
|
|
U
|
Reek::Smells::TooManyStatements.default_config |
|
|
U
|
Reek::Core::SingletonMethodContext#initialize |
|
|
U
|
Reek::Smells::UtilityFunction.default_config |
|
|
U
|
Reek::Smells::NestedIterators.default_config |
|
|
U
|
Reek::Smells::TooManyMethods.default_config |
|
|
U
|
Reek::Smells::LongYieldList.default_config |
|
|
U
|
Reek::Smells::PrimaDonnaMethod.contexts |
|
|
U
|
Reek::Smells::DataClump.default_config |
|
|
U
|
Reek::Smells::Attribute.default_config |
|
|
U
|
Reek::Core::MethodContext#initialize |
|
|
U
|
Reek::Core::ModuleContext#initialize |
|
|
U
|
Reek::Source::SourceCode::@@err_io |
|
Let's raise the visibility of documentation in Ruby!
This page is for troessner/reek and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
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.
nch Pages