Sign upLogin

Cimpress-MCP/JustReleaseNotes

View on GitHub
Star
JustReleaseNotes/writers/JsonWriter.py

Summary

Maintainability
A
25 mins
Test Coverage

Function printVersionBlock has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    def printVersionBlock(self, deps, version, date, tickets):

        # get the content of a specific version if already present
        if version in self.versionsAlreadyPresent.keys():
            return json.dumps(self.versionsAlreadyPresent[version], indent=2, sort_keys=True)
Severity: Minor
Found in JustReleaseNotes/writers/JsonWriter.py - About 25 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