Sign upLogin

rrrene/inch

View on GitHub
Star
lib/inch/language/ruby/provider/yard/nodoc_helper.rb

Summary

Maintainability
A
2 hrs
Test Coverage

Method implicit_nodoc_comment? has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

            def implicit_nodoc_comment?
              return false if explicit_doc_comment?

              if parent
                return false if parent.explicit_doc_comment?
Severity: Minor
Found in lib/inch/language/ruby/provider/yard/nodoc_helper.rb - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid too many return statements within this method.
Open

                    return true
Severity: Major
Found in lib/inch/language/ruby/provider/yard/nodoc_helper.rb - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

                        return parent.implicit_nodoc_all_comment?
    Severity: Major
    Found in lib/inch/language/ruby/provider/yard/nodoc_helper.rb - About 30 mins to fix

      There are no issues that match your filters.

      Category
      Status