lib/dox/printers/base_printer.rb
Method read_file
has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open
Open
def read_file(path, config_root_path: Dox.config.descriptions_location)
return '' unless config_root_path
config_root_path.each do |root_path|
file_path = File.join(root_path, path)
- Read upRead up
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"