pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-03-29 10:36:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review

Browse source 
Co-authored-by: Ian Stapleton Cordasco <graffatcolmingov@gmail.com>
This commit is contained in:
Paciupa 2024-02-07 17:51:46 +03:00 • committed by GitHub
parent 74dba5b965
commit aa51e6662b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -136,25 +136,31 @@ the errors in that file will show up without having to modify our
configuration. Both exist so we can choose which is better for us.
Ignoring Violations for some Files
-----------------------
Ignoring Violations in Specific Files
-------------------------------------
Sometimes, we might want to ignore some error codes (or class of error codes) for
some part of our project (tests for example).
We can do this using :option:`flake8 --per-file-ignores` from CLI:
If we want to ignore one or more violation codes for certain files, you can
use the :option:`flake8 --per-file-ignores` on either the command-line
or in your configuration file.
.. prompt:: bash
flake8 --per-file-ignores='project/test.py:F841 setup.py:E121'
flake8 --per-file-ignores='tests/*:F841 setup.py:E121'
flake8 --per-file-ignores='project/test.py:F841 setup.py:E121'
flake8 --per-file-ignores='tests/*:F841,D setup.py:E121'
.. note::
While most options in Flake8 use commas to separate values, this option allows
multiple violation codes to be specified per file with commas so to specify
multiple file mappings use spaces to delimit them.
We can also specify it in config file:
.. code-block:: ini
per-file-ignores =
project/test.py:F841
tests/*:F841
tests/*:F841,D
setup.py:E121
other_project/*:W9