Lambda-School-Labs/pt-synaps-ds

View on GitHub
retrieve_definition.py

Summary

Maintainability
A
1 hr
Test Coverage

Function retrieve_definition has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

def retrieve_definition(term, term_wrangled=False):
    """
    Given a term, returns the first 190 characters of the matching Wikipedia
    page. If no term is found, returns a "Did you mean...?" prompt with three
    terms that do have matching pages.
Severity: Minor
Found in retrieve_definition.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

There are no issues that match your filters.

Category
Status