Sign upLogin

ssokolow/quicktile

View on GitHub
Star
docs/conf.py

Summary

Maintainability
A
45 mins
Test Coverage

Function format_annotation has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

def format_annotation(annotation, *args, **kwargs):
    """Wrapper to override lookup for certain autodoc cross-references"""
    if inspect.isclass(annotation):
        full_name = '{}.{}'.format(
            annotation.__module__, annotation.__qualname__)
Severity: Minor
Found in docs/conf.py - About 45 mins 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

TODO found
Open

        # TODO: Make this generate a cross-reference target
Severity: Minor
Found in docs/conf.py by fixme

TODO found
Open

# TODO: Investigate how much work it would be to contribute intersphinx
Severity: Minor
Found in docs/conf.py by fixme

TODO found
Open

# TODO: Check how this affects the output
Severity: Minor
Found in docs/conf.py by fixme

There are no issues that match your filters.

Category
Status