Build #11 (all) Revision 5d5350a7 Source github.com Documentation rubydoc.info

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.

Read the docs

Seems really good
A
String N
A
File N
A
IO N
A
Reek::Rake::Task N
A
Reek::Core::CodeParser Ne
Show 92 more ...
A
Reek::SmellWarning Ne
A
Reek Ne
A
Reek::Smells::ControlParameter::ControlParameterCollector Ne
A
Reek::Smells::ControlParameter::FoundControlParameter Ne
A
Reek::Smells::DuplicateMethodCall::CallCollector Ne
A
Reek::Smells::DuplicateMethodCall::FoundCall Ne
A
Reek::Smells::UncommunicativeParameterName Ne
A
Reek::Smells::UncommunicativeVariableName Ne
A
Reek::Smells::UncommunicativeMethodName Ne
A
Reek::Core::WarningCollector#initialize Ne
A
Reek::Smells::UncommunicativeModuleName Ne
A
Reek::Smells::TooManyInstanceVariables Ne
A
Reek::Smells::NilCheck::CaseNodeFinder Ne
A
Reek::Smells::NilCheck::CallNodeFinder Ne
A
Reek::Smells::NilCheck::NodeFinder Ne
A
Reek::Core::StopContext#initialize Ne
A
Reek::Core::SingletonMethodContext Ne
A
Reek::Smells::IrresponsibleModule Ne
A
Reek::Smells::DuplicateMethodCall Ne
A
Reek::Smells::RepeatedConditional Ne
A
Reek::Smells::TooManyStatements Ne
A
Reek::Smells::LongParameterList Ne
A
Reek::Smells::ControlParameter Ne
A
Reek::Smells::BooleanParameter Ne
A
Reek::Smells::UnusedParameters Ne
A
Reek::Core::SmellConfiguration Ne
A
Reek::Smells::PrimaDonnaMethod Ne
A
Reek::Smells::UtilityFunction Ne
A
Reek::Smells::NestedIterators Ne
A
Reek::Core::MethodParameters Ne
A
Reek::Smells::TooManyMethods Ne
A
Reek::Core::WarningCollector Ne
A
Reek::Examiner#smells_count Ne
A
Reek::Smells::SmellDetector Ne
A
Reek::Core::SmellRepository Ne
A
Reek::Smells::LongYieldList Ne
A
Reek::SmellWarning#location Ne
A
Reek::Smells::ClassVariable Ne
A
Reek::Smells::FeatureEnvy Ne
A
Reek::Cli::VersionCommand Ne
A
Reek::Core::MethodContext Ne
A
Reek::Core::ModuleContext Ne
A
Reek::SmellWarning#status Ne
A
Reek::SmellWarning#smell Ne
A
Reek::Cli::VerboseReport Ne
A
Reek::Core::StopContext Ne
A
Reek::Core::CodeContext Ne
A
Reek::Smells::DataClump Ne
A
Reek::Smells::Attribute Ne
A
Reek::Smells::NilCheck Ne
A
Reek::Cli::Application Ne
A
Reek::Cli::ReekCommand Ne
A
Reek::Cli::HelpCommand Ne
A
Reek::Cli::QuietReport Ne
A
String#to_reek_source Ne
A
Reek::Core::Overrides Ne
A
Reek::Cli::HtmlReport Ne
A
Reek::Examiner#smells Ne
A
File#to_reek_source Ne
A
Reek::Core::Sniffer Ne
A
Reek::Cli::Command Ne
A
Reek::Cli::Options Ne
A
Reek::Cli::Report Ne
A
Reek::Spec#reek Ne
A
Reek::Examiner Ne
A
Reek::Spec Ne
A
Reek::Smells::SmellDetector#smells_found Ne
A
Reek::Rake::Task#fail_on_error= Ne
A
Reek::Rake::Task#fail_on_error Ne
A
Reek::Rake::Task#source_files= Ne
A
Reek::Rake::Task#config_files= Ne
A
Reek::Rake::Task#source_files Ne
A
Reek::Rake::Task#config_files Ne
A
Reek::Rake::Task#reek_opts= Ne
A
Reek::Rake::Task#ruby_opts= Ne
A
Reek::Examiner#description= Ne
A
Reek::Rake::Task#ruby_opts Ne
A
Reek::Examiner#description Ne
A
Reek::Rake::Task#reek_opts Ne
A
Reek::Rake::Task#verbose= Ne
A
Reek::Rake::Task#verbose Ne
A
Reek::Rake::Task#libs= Ne
A
Reek::Rake::Task#name= Ne
A
Reek::Rake::Task#name Ne
A
Reek::Rake::Task#libs Ne
A
Reek::Smells::DuplicateMethodCall#examine_context Ne
A
Reek::Smells::TooManyMethods#examine_context Ne
A
Reek::Examiner#num_active_smells E
A
Reek::Examiner#num_masked_smells E
A
Reek::Examiner#all_active_smells E
A
Reek::Examiner#all_smells E
A
Reek::Rake::Task#initialize E
Proper documentation present
B
Reek::Core::CodeParser#process_call N
B
Reek::Spec#reek_of Ne
B
Reek::Core::CodeContext#method_missing Ne
B
Reek::Spec#reek_only_of Ne
B
Reek::Core::SmellConfiguration#value Ne
Show 24 more ...
B
Reek::Smells::UncommunicativeParameterName#examine_context Ne
B
Reek::Smells::UncommunicativeVariableName#examine_context Ne
B
Reek::Smells::UncommunicativeMethodName#examine_context Ne
B
Reek::Smells::UncommunicativeModuleName#examine_context Ne
B
Reek::Smells::TooManyInstanceVariables#examine_context Ne
B
Reek::Smells::RepeatedConditional#examine_context Ne
B
Reek::Smells::IrresponsibleModule#examine_context Ne
B
Reek::Smells::TooManyStatements#examine_context Ne
B
Reek::Smells::LongParameterList#examine_context Ne
B
Reek::Smells::BooleanParameter#examine_context Ne
B
Reek::Smells::UnusedParameters#examine_context Ne
B
Reek::Smells::ControlParameter#examine_context Ne
B
Reek::Smells::NestedIterators#examine_context Ne
B
Reek::Smells::UtilityFunction#examine_context Ne
B
Reek::Smells::ClassVariable#examine_context Ne
B
Reek::Smells::LongYieldList#examine_context Ne
B
Reek::Smells::FeatureEnvy#examine_context Ne
B
Reek::Smells::Attribute#examine_context Ne
B
Reek::Smells::DataClump#examine_context Ne
B
IO#to_reek_source Ne
B
Reek::Smells::RepeatedConditional#conditional_counts Ne
B
Reek::Smells::ClassVariable#class_variables_in Ne
B
Reek::Core::CodeParser#process_iter Ne
B
Reek::Core::Overrides#for_context Ne
Please take a look
C
Reek::Examiner#initialize N
Undocumented
U
Reek::Core::SmellConfiguration#merge! N
U
Reek::Core::CodeParser#process_self N
U
Reek::Core::CodeParser#process_module N
U
Reek::Core::CodeParser#process_while N
U
Reek::Core::CodeParser#process_ivar N
Show 155 more ...
U
Reek::SmellWarning#initialize N
U
Reek::Cli::Report#initialize N
U
Reek::Core::StopContext#method_missing Ne
U
Reek::Core::CodeParser#process_args Ne
U
Reek::Core::CodeContext#local_nodes Ne
U
Reek::Core::StopContext#config_for Ne
U
Reek::Core::CodeContext#each_node Ne
U
Reek::Smells::UncommunicativeVariableName#find_block_argument_variable_names Ne
U
Reek::Smells::ControlParameter::ControlParameterCollector#control_parameters Ne
U
Reek::Smells::UncommunicativeVariableName#recursively_record_variable_names Ne
U
Reek::Smells::UncommunicativeVariableName#find_assignment_variable_names Ne
U
Reek::Smells::ControlParameter::ControlParameterCollector#initialize Ne
U
Reek::Smells::ControlParameter::FoundControlParameter#smell_message Ne
U
Reek::Smells::ControlParameter::FoundControlParameter#initialize Ne
U
Reek::Smells::UncommunicativeVariableName#record_variable_name Ne
U
Reek::Smells::DuplicateMethodCall::CallCollector#smelly_calls Ne
U
Reek::Smells::ControlParameter::FoundControlParameter#record Ne
U
Reek::Smells::DuplicateMethodCall::CallCollector#initialize Ne
U
Reek::Smells::ControlParameter::FoundControlParameter#lines Ne
U
Reek::Smells::ControlParameter::FoundControlParameter#name Ne
U
Reek::Smells::DuplicateMethodCall::FoundCall#smell_message Ne
U
Reek::Smells::UncommunicativeVariableName#variable_names Ne
U
Reek::Smells::DuplicateMethodCall::CallCollector#context Ne
U
Reek::Smells::DuplicateMethodCall::FoundCall#initialize Ne
U
Reek::Smells::DuplicateMethodCall::CallCollector#calls Ne
U
Reek::Smells::DuplicateMethodCall::FoundCall#record Ne
U
Reek::Smells::DuplicateMethodCall::FoundCall#occurs Ne
U
Reek::Smells::DuplicateMethodCall::FoundCall#lines Ne
U
Reek::Cli::WarningFormatterWithLineNumbers.format Ne
U
Reek::Smells::DuplicateMethodCall::FoundCall#call Ne
U
Reek::Core::MethodParameters#default_assignments Ne
U
Reek::Smells::ExcludeInitialize.default_config Ne
U
Reek::Smells::PrimaDonnaMethod#examine_context Ne
U
Reek::Smells::NilCheck::NodeFinder#initialize Ne
U
Reek::Core::CodeContext#node_instance_methods Ne
U
Reek::Smells::NilCheck::CaseNodeFinder#smelly Ne
U
Reek::Smells::NilCheck::CallNodeFinder#smelly Ne
U
Reek::Cli::SingleLineWarningFormatter.format Ne
U
Reek::Core::SmellConfiguration#overrides_for Ne
U
Reek::Core::MethodContext#record_use_of_self Ne
U
Reek::Smells::SmellDetector.smell_class_name Ne
U
Reek::Core::MethodContext#envious_receivers Ne
U
Reek::Cli::WarningFormatterWithLineNumbers Ne
U
Reek::Smells::SmellDetector.default_config Ne
U
Reek::Smells::SmellDetector#configure_with Ne
U
Reek::Core::MethodContext#count_statements Ne
U
Reek::Core::SmellRepository.smell_classes Ne
U
Reek::Core::SmellConfiguration#initialize Ne
U
Reek::Core::StopContext#count_statements Ne
U
Reek::Core::MethodContext#num_statements Ne
U
Reek::Core::WarningCollector#found_smell Ne
U
Reek::Core::MethodContext#record_call_to Ne
U
Reek::Cli::SimpleWarningFormatter.format Ne
U
Reek::Cli::VerboseReport#gather_results Ne
U
Reek::Core::MethodContext#unused_params Ne
U
Reek::Smells::NilCheck#examine_context Ne
U
Reek::Smells::SmellDetector#initialize Ne
U
Reek::Core::CodeParser#process_default Ne
U
Reek::Smells::SmellDetector#config_for Ne
U
Reek::Core::SmellRepository#initialize Ne
U
Reek::Core::CodeParser#process_resbody Ne
U
Reek::Cli::ReportFormatter.format_list Ne
U
Reek::Core::SmellRepository#configure Ne
U
Reek::Core::SmellRepository#report_on Ne
U
Reek::Core::WarningCollector#warnings Ne
U
Reek::Cli::QuietReport#gather_results Ne
U
Reek::Cli::SingleLineWarningFormatter Ne
U
Reek::Smells::SmellDetector#report_on Ne
U
Reek::Cli::Application#report_success Ne
U
Reek::Core::CodeParser#process_rescue Ne
U
Reek::Smells::SmellDetector#register Ne
U
Reek::Smells::SmellDetector.contexts Ne
U
Reek::Core::CodeParser#process_block Ne
U
Reek::Cli::Application#report_smells Ne
U
Reek::Core::MethodContext#parameters Ne
U
Reek::Core::CodeParser#process_defn Ne
U
Reek::Smells::SmellDetector#examine Ne
U
Reek::Core::SmellRepository#examine Ne
U
Reek::Core::CodeParser#process_case Ne
U
Reek::Core::CodeContext#num_methods Ne
U
Reek::Core::CodeParser#process_defs Ne
U
Reek::Core::CodeParser#process_when Ne
U
Reek::Core::CodeContext#config_for Ne
U
Reek::Core::CodeContext#initialize Ne
U
Reek::Core::CodeParser#process_for Ne
U
Reek::Cli::SimpleWarningFormatter Ne
U
Reek::Core::StopContext#full_name Ne
U
Reek::Cli::ReportFormatter.header Ne
U
Reek::Core::CodeParser#process_if Ne
U
Reek::Core::CodeContext#full_name Ne
U
Reek::Cli::Application#initialize Ne
U
Reek::Cli::VersionCommand#execute Ne
U
Reek::Smells::SmellDetector#value Ne
U
Reek::Core::CodeParser#initialize Ne
U
Reek::Core::Overrides#initialize Ne
U
Reek::Cli::Options#program_name Ne
U
Reek::Cli::Options#config_files Ne
U
Reek::Smells::ExcludeInitialize Ne
U
Reek::Cli::Options#get_sources Ne
U
Reek::Cli::ReekCommand#execute Ne
U
Reek::Core::CodeParser#process Ne
U
Reek::SmellWarning#smell_class Ne
U
Reek::Core::Sniffer#initialize Ne
U
Reek::Core::MethodContext#refs Ne
U
Reek::Cli::Report#add_examiner Ne
U
Reek::Cli::Options#set_options Ne
U
Reek::Cli::Application#execute Ne
U
Reek::Cli::HelpCommand#execute Ne
U
Reek::Cli::Application#output Ne
U
Reek::Core::Sniffer#configure Ne
U
Reek::Core::Sniffer#report_on Ne
U
Reek::Cli::Options#initialize Ne
U
Reek::Cli::Command#initialize Ne
U
Reek::Cli::Options#help_text Ne
U
Reek::Cli::HtmlReport#output Ne
U
Reek::SmellWarning#report_on Ne
U
Reek::SmellWarning#is_active Ne
U
Reek::Core::CodeContext#name Ne
U
Reek::SmellWarning#subclass Ne
U
Reek::Cli::Options#reporter Ne
U
Reek::Core::CodeContext#exp Ne
U
Reek::Core::Sniffer#examine Ne
U
Reek::SmellWarning#message Ne
U
Reek::Cli::ReportFormatter Ne
U
Reek::SmellWarning#context Ne
U
Reek::SmellWarning#source Ne
U
Reek::Cli::Options#banner Ne
U
Reek::Cli::Options#parse Ne
U
Reek::SmellWarning#lines Ne
U
Reek::SmellWarning#hash Ne
U
Reek::SmellWarning#<=> Ne
U
Reek::Cli::Report#show Ne
U
Reek::SmellWarning#sort_key E
U
Reek::Smells::UncommunicativeParameterName.default_config E
U
Reek::Smells::UncommunicativeVariableName.default_config E
U
Reek::Smells::UncommunicativeModuleName.default_config E
U
Reek::Smells::UncommunicativeMethodName.default_config E
U
Reek::Smells::TooManyInstanceVariables.default_config E
U
Reek::Core::SingletonMethodContext#envious_receivers E
U
Reek::Smells::NilCheck::CallNodeFinder#initialize E
U
Reek::Smells::NilCheck::CaseNodeFinder#initialize E
U
Reek::Smells::RepeatedConditional.default_config E
U
Reek::Smells::DuplicateMethodCall.default_config E
U
Reek::Smells::LongParameterList.default_config E
U
Reek::Smells::TooManyStatements.default_config E
U
Reek::Core::SingletonMethodContext#initialize E
U
Reek::Smells::NestedIterators.default_config E
U
Reek::Smells::UtilityFunction.default_config E
U
Reek::Smells::TooManyMethods.default_config E
U
Reek::Smells::LongYieldList.default_config E
U
Reek::Smells::PrimaDonnaMethod.contexts E
U
Reek::Smells::Attribute.default_config E
U
Reek::Smells::DataClump.default_config E
U
Reek::Core::ModuleContext#initialize E
U
Reek::Core::MethodContext#initialize E

Let's raise the visibility of documentation in Ruby!

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!

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.

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