diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/user/options.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst index 1cbc22f..cb3e949 100644 --- a/docs/source/user/options.rst +++ b/docs/source/user/options.rst @@ -58,6 +58,8 @@ Index of Options - :option:`flake8 --extend-ignore` +- :option:`flake8 --per-file-ignores` + - :option:`flake8 --max-line-length` - :option:`flake8 --select` @@ -449,6 +451,38 @@ Options and their Descriptions 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> :ref:`Go back to index <top>` |