summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIan Stapleton Cordasco <graffatcolmingov@gmail.com>2018-05-20 14:46:10 +0000
committerIan Stapleton Cordasco <graffatcolmingov@gmail.com>2018-05-20 14:46:10 +0000
commit30b0e4599a5a3b6b6acce924e9bb7c082541c5be (patch)
treefb973dd1e32e9b8e7b07f6b76de9d65ddb3fb3d0 /docs
parent52210149474a876c06922ae2c296445af5bdb108 (diff)
parente8e35ea0aebf81b0db8b1cace36f5bc3c4ec541e (diff)
downloadflake8-30b0e4599a5a3b6b6acce924e9bb7c082541c5be.tar.gz
Merge branch 'extend-ignore' into 'master'
Implement --extend-ignore See merge request pycqa/flake8!233
Diffstat (limited to 'docs')
-rw-r--r--docs/source/user/invocation.rst4
-rw-r--r--docs/source/user/options.rst33
2 files changed, 37 insertions, 0 deletions
diff --git a/docs/source/user/invocation.rst b/docs/source/user/invocation.rst
index d96d0f9..c469f37 100644
--- a/docs/source/user/invocation.rst
+++ b/docs/source/user/invocation.rst
@@ -107,6 +107,10 @@ And you should see something like:
--ignore=errors Comma-separated list of errors and warnings to ignore
(or skip). For example, ``--ignore=E4,E51,W234``.
(Default: E121,E123,E126,E226,E24,E704)
+ --extend-ignore=errors
+ Comma-separated list of errors and warnings to add to
+ the list of ignored ones. For example, ``--extend-
+ ignore=E4,E51,W234``.
--max-line-length=n Maximum allowed line length for the entirety of this
run. (Default: 79)
--select=errors Comma-separated list of errors and warnings to enable.
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst
index 4922c1a..1cbc22f 100644
--- a/docs/source/user/options.rst
+++ b/docs/source/user/options.rst
@@ -56,6 +56,8 @@ Index of Options
- :option:`flake8 --ignore`
+- :option:`flake8 --extend-ignore`
+
- :option:`flake8 --max-line-length`
- :option:`flake8 --select`
@@ -416,6 +418,37 @@ Options and their Descriptions
ignore = E121,E123
+.. option:: --extend-ignore=<errors>
+
+ :ref:`Go back to index <top>`
+
+ 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.
+
+ The difference to the :option:`--ignore` option is, that this option can be
+ used to selectively add individual codes without overriding the default
+ list entirely.
+
+ Command-line example:
+
+ .. prompt:: bash
+
+ flake8 --extend-ignore=E4,E51,W234 dir/
+
+ This **can** be specified in config files.
+
+ Example config file usage:
+
+ .. code-block:: ini
+
+ extend-ignore =
+ E4,
+ E51,
+ W234
+ extend-ignore = E4,E51,W234
+
+
.. option:: --max-line-length=<n>
:ref:`Go back to index <top>`