pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-07 05:26:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update information on default ignore list

Browse source 
The paragraph directly under "Ignoring Violations with Flake8" was a
less specific version of the same information under the last paragraph
of "Extending the Default Ignore List." To remove the duplication, I
suggest combining the two paragraphs together and giving it its own
heading to make sure it stands out. But, if there's a better way of
organizing, I'm open to suggestions and can revise this accordingly.

Add a link to the glossary for error classes.
This commit is contained in:
Josh Kelley 2019-02-01 13:02:57 -05:00
parent 79148a02ee
commit a2ebd43844
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/source/user/violations.rst
View file

@ -13,10 +13,15 @@ based on different inputs.
Ignoring Violations with Flake8
===============================
The Default Ignore List
-----------------------
By default, |Flake8| has a list of error codes that it ignores. The list used
by a version of |Flake8| may be different than the list used by a different
version. To see the default list, :option:`flake8 --help` will
show the output with the current default list.
by one version of |Flake8| may be different than the list used by a different
version. To view the default error code ignore list, run
:option:`flake8 --help` and refer to the help text for
:option:`flake8 --ignore`.
Extending the Default Ignore List
---------------------------------
@ -30,9 +35,7 @@ for a specific run on the command line, e.g.,
flake8 --extend-ignore=E1,E23 path/to/files/ path/to/more/files
This tells |Flake8| to ignore any error codes starting with ``E1`` and ``E23``,
in addition the default ignore list. To view the default error code ignore
list, run :option:`flake8 --help` and refer to the help text for
:option:`flake8 --ignore`.
in addition the default ignore list.
..
@ -129,7 +132,8 @@ configuration. Both exist so we can choose which is better for us.
Selecting Violations with Flake8
================================
|Flake8| has a default list of violation classes that we use. This list is:
|Flake8| has a default list of violation :term:`class`\ es that we use. This
list is:
- ``C90``