From 19148eb5d74684dbaa249619a1b60325ffc5f7ac Mon Sep 17 00:00:00 2001 From: Ian Stapleton Cordasco Date: Sat, 27 Oct 2018 07:51:55 -0500 Subject: Add documentation for --per-file-ignores --- docs/source/user/options.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'docs/source/user') 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=[ ] + + :ref:`Go back to index ` + + 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= :ref:`Go back to index ` -- cgit v1.2.1 From 6ae2295bfeea68c11a7d13282a9bfde1a553449b Mon Sep 17 00:00:00 2001 From: Ian Stapleton Cordasco Date: Sat, 27 Oct 2018 11:58:31 -0500 Subject: Add versionadded notes for options --- docs/source/user/options.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/source/user') diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst index cb3e949..00164ae 100644 --- a/docs/source/user/options.rst +++ b/docs/source/user/options.rst @@ -424,6 +424,8 @@ Options and their Descriptions :ref:`Go back to index ` + .. versionadded:: 3.6.0 + Specify a list of codes to add to the list of ignored ones. Similar considerations as in :option:`--ignore` apply here with regard to the value. @@ -455,6 +457,8 @@ Options and their Descriptions :ref:`Go back to index ` + .. versionadded:: 3.7.0 + 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 @@ -777,6 +781,8 @@ Options and their Descriptions :ref:`Go back to index ` + .. versionadded:: 3.6.0 + Provide extra config files to parse in after and in addition to the files that |Flake8| found on its own. Since these files are the last ones read into the Configuration Parser, so it has the highest precedence if it -- cgit v1.2.1