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

Prefer extend-ignore over ignore in general examples

Browse source
This commit is contained in:
wookie184 2022-09-06 18:29:02 +01:00
parent 4d1a72afc2
commit a3e31c2f44
2 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/index.rst
View file

@ -60,11 +60,11 @@ If you only want to see the instances of a specific warning or error, you can
flake8 --select E123,W503 path/to/code/ flake8 --select E123,W503 path/to/code/
Alternatively, if you want to *ignore* only one specific warning or error: Alternatively, if you want to add a specific warning or error to *ignore*:
.. code:: .. code::
flake8 --ignore E24,W504 path/to/code/ flake8 --extend-ignore E203,W234 path/to/code/
Please read our user guide for more information about how to use and configure Please read our user guide for more information about how to use and configure
|Flake8|. |Flake8|.

12
docs/source/user/configuration.rst
View file

@ -90,7 +90,7 @@ Let's actually look at |Flake8|'s own configuration section:
.. code-block:: ini .. code-block:: ini
[flake8] [flake8]
ignore = D203 extend-ignore = E203
exclude = .git,__pycache__,docs/source/conf.py,old,build,dist exclude = .git,__pycache__,docs/source/conf.py,old,build,dist
max-complexity = 10 max-complexity = 10
@ -98,7 +98,7 @@ This is equivalent to:
.. prompt:: bash .. prompt:: bash
flake8 --ignore D203 \ flake8 --extend-ignore E203 \
--exclude .git,__pycache__,docs/source/conf.py,old,build,dist \ --exclude .git,__pycache__,docs/source/conf.py,old,build,dist \
--max-complexity 10 --max-complexity 10
@ -107,7 +107,7 @@ In our case, if we wanted to, we could also do
.. code-block:: ini .. code-block:: ini
[flake8] [flake8]
ignore = D203 extend-ignore = E203
exclude = exclude =
.git, .git,
__pycache__, __pycache__,
@ -122,7 +122,7 @@ This allows us to add comments for why we're excluding items, e.g.
.. code-block:: ini .. code-block:: ini
[flake8] [flake8]
ignore = D203 extend-ignore = E203
exclude = exclude =
# No need to traverse our git directory # No need to traverse our git directory
.git, .git,
@ -190,7 +190,7 @@ look at a portion of a project's Flake8 configuration in their ``tox.ini``:
# H404: multi line docstring should start without a leading new line # H404: multi line docstring should start without a leading new line
# H405: multi line docstring summary not separated with an empty line # H405: multi line docstring summary not separated with an empty line
# H501: Do not use self.__dict__ for string formatting # H501: Do not use self.__dict__ for string formatting
ignore = H101,H202,H233,H301,H306,H401,H403,H404,H405,H501 extend-ignore = H101,H202,H233,H301,H306,H401,H403,H404,H405,H501
They use the comments to describe the check but they could also write this as: They use the comments to describe the check but they could also write this as:
@ -198,7 +198,7 @@ They use the comments to describe the check but they could also write this as:
[flake8] [flake8]
# it's not a bug that we aren't using all of hacking # it's not a bug that we aren't using all of hacking
ignore = extend-ignore =
# H101: Use TODO(NAME) # H101: Use TODO(NAME)
H101, H101,
# H202: assertRaises Exception too broad # H202: assertRaises Exception too broad