pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-11 15:24:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix documentation for the --count option

Browse source 
It erroneously claimed that it set the application exit code to 1 if the
count was greater than 1. However, this is false, because the --count
option doesn't modify the error code at any time.

If the count was greater than 1, then the exit code was already 1, even
in the absence of --count, unless --exit-zero was used.

This documentation bug resulted in people reading the `flake8 --help`
output and believing that --count is mandatory in order to ensure that
flake8 produces errors in automated processes (such as CI scripts) when
flake8 violations are detected.
This commit is contained in:
Eli Schwartz 2022-09-22 20:28:48 -04:00
parent 4be02109df
commit 045923237e
No known key found for this signature in database
GPG key ID: CEB167EFB5722BD6
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/flake8/main/options.py
View file

@ -159,8 +159,8 @@ def register_default_options(option_manager: OptionManager) -> None:
"--count", "--count",
action="store_true", action="store_true",
parse_from_config=True, parse_from_config=True,
help="Print total number of errors to standard output and " help="Print total number of errors to standard output after "
"set the exit code to 1 if total is not empty.", "all other output.",
) )
add_option( add_option(