mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-12 15:44:17 +00:00
Add documentation for --per-file-ignores
This commit is contained in:
parent
e09a22a416
commit
19148eb5d7
1 changed files with 34 additions and 0 deletions
|
|
@ -58,6 +58,8 @@ Index of Options
|
||||||
|
|
||||||
- :option:`flake8 --extend-ignore`
|
- :option:`flake8 --extend-ignore`
|
||||||
|
|
||||||
|
- :option:`flake8 --per-file-ignores`
|
||||||
|
|
||||||
- :option:`flake8 --max-line-length`
|
- :option:`flake8 --max-line-length`
|
||||||
|
|
||||||
- :option:`flake8 --select`
|
- :option:`flake8 --select`
|
||||||
|
|
@ -449,6 +451,38 @@ Options and their Descriptions
|
||||||
extend-ignore = E4,E51,W234
|
extend-ignore = E4,E51,W234
|
||||||
|
|
||||||
|
|
||||||
|
.. option:: --per-file-ignores=<filename:errors>[ <filename:errors>]
|
||||||
|
|
||||||
|
:ref:`Go back to index <top>`
|
||||||
|
|
||||||
|
Specify a list of mappings of files and the codes that should be ignored
|
||||||
|
for the entirety of the file. This allows for a project to have a default
|
||||||
|
list of violations that should be ignored as well as file-specific
|
||||||
|
violations for files that have not been made compliant with the project
|
||||||
|
rules.
|
||||||
|
|
||||||
|
This option supports syntax similar to :option:`--exclude` such that glob
|
||||||
|
patterns will also work here.
|
||||||
|
|
||||||
|
This can be combined with both :option:`--ignore` and
|
||||||
|
:option:`--extend-ignore` to achieve a full flexibility of style options.
|
||||||
|
|
||||||
|
Command-line usage:
|
||||||
|
|
||||||
|
.. prompt:: bash
|
||||||
|
|
||||||
|
flake8 --per-file-ignores='project/__init__.py:F401 setup.py:E121'
|
||||||
|
flake8 --per-file-ignores='project/*/__init__.py:F401 setup.py:E121'
|
||||||
|
|
||||||
|
This **can** be specified in config files.
|
||||||
|
|
||||||
|
.. code-block:: ini
|
||||||
|
|
||||||
|
per-file-ignores =
|
||||||
|
project/__init__.py:F401
|
||||||
|
setup.py:E121
|
||||||
|
other_project/*:W9
|
||||||
|
|
||||||
.. option:: --max-line-length=<n>
|
.. option:: --max-line-length=<n>
|
||||||
|
|
||||||
:ref:`Go back to index <top>`
|
:ref:`Go back to index <top>`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue