Sign upLogin

rrrene/inch

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

Summary

Maintainability
A
3 hrs
Test Coverage

Class Docstring has 21 methods (exceeds 20 allowed). Consider refactoring.
Open

          class Docstring
            def initialize(text)
              @text = text.to_s
            end
Severity: Minor
Found in lib/inch/language/ruby/provider/yard/docstring.rb - About 2 hrs to fix

    Method parse_code_examples has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

                def parse_code_examples
              code_examples = []
              example = nil
              @text.lines.each do |line|
                if line =~ /^\s*+$/
    Severity: Minor
    Found in lib/inch/language/ruby/provider/yard/docstring.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

    There are no issues that match your filters.

    Category
    Status