Sign upLogin

ICTU/quality-time

View on GitHub
Star
docs/src/create_reference_md.py

Summary

Maintainability
B
4 hrs
Test Coverage

File create_reference_md.py has 269 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""Script to convert the data model in a Markdown file."""

import pathlib
import re
from typing import Literal
Severity: Minor
Found in docs/src/create_reference_md.py - About 2 hrs to fix

    Function parameter_description has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def parameter_description(parameter: Parameter) -> str:
    """Return the Markdown version of the parameter."""
    short_name = parameter.short_name
    help_text = " " + parameter.help if parameter.help else ""
    if parameter.type in ("single_choice", "multiple_choice"):
    Severity: Minor
    Found in docs/src/create_reference_md.py - 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

    Function metric_section has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def metric_section(metric_key: str, metric: Metric, level: int) -> str:
    """Return the metric as Markdown section."""
    markdown = markdown_header(metric.name, level=level, index=True)
    markdown += markdown_paragraph(metric.description)
    name = decapitalize(metric.name)
    Severity: Minor
    Found in docs/src/create_reference_md.py - About 35 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

    There are no issues that match your filters.

    Category
    Status