radon icon indicating copy to clipboard operation
radon copied to clipboard

Documentation Option wrong spelling

Open HenryBlairG opened this issue 1 year ago • 1 comments

I found that in this part of the docs that the config property that is mentioned is functions, and trying out in my project discover that is actually function. Maybe it could help others in the future to fix this tiny detail.

Great Library!!

HenryBlairG avatar Jun 06 '24 21:06 HenryBlairG

@HenryBlairG Hi Henry, could you clarify? The documentation shows the option name is -f, --functions and the help command matches that:

$ radon hal -h
usage: radon hal [-h] [-e <str>] [-i <str>] [-j] [-f] [-O <str>] [--include-ipynb] [--ipynb-cells] paths [paths ...]

The Halstead metrics are a series of measurements meant to quantitatively measure the complexity of code, including the
difficulty a programmer would have in writing it.

positional arguments:
  paths                 The paths where to find modules or packages to analyze. More than one path is allowed.

options:
  -h, --help            show this help message and exit
  -e <str>, --exclude <str>
                        Exclude files only when their path matches one of these glob patterns. Usually needs quoting at the
                        command line.
  -i <str>, --ignore <str>
                        Ignore directories when their name matches one of these glob patterns: radon won't even descend into
                        them. By default, hidden directories (starting with '.') are ignored.
  -j, --json            Format results in JSON.
  -f, --functions       Analyze files by top-level functions instead of as a whole.
  -O <str>, --output-file <str>
                        The output file (default to stdout).
  --include-ipynb       Include IPython Notebook files
  --ipynb-cells         Include reports for individual IPYNB cells

The --function (singular) option doesn't exist.

rubik avatar Oct 20 '24 12:10 rubik