summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThomas Grainger <tagrain@gmail.com>2019-07-08 20:12:47 +0000
committerAnthony Sottile <asottile@umich.edu>2019-07-08 20:12:47 +0000
commit9ba6677c4ae4248b0f31d861a608db2efcc2679a (patch)
treedb73dbc99c0341846aad71fc47a5a59a633ca34b /docs
parent0d7247082efbe6e8189abd4eeb49a4ee3a128253 (diff)
downloadflake8-9ba6677c4ae4248b0f31d861a608db2efcc2679a.tar.gz
support extend-exclude Fixes #535
Diffstat (limited to 'docs')
-rw-r--r--docs/source/user/options.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst
index 3b1c43d..ce0cf18 100644
--- a/docs/source/user/options.rst
+++ b/docs/source/user/options.rst
@@ -257,6 +257,38 @@ Options and their Descriptions
__pycache__
+.. option:: --extend-exclude=<patterns>
+
+ :ref:`Go back to index <top>`
+
+ .. versionadded:: 3.8.0
+
+ Provide a comma-separated list of glob patterns to add to the list of excluded ones.
+ Similar considerations as in :option:`--exclude` apply here with regard to the
+ value.
+
+ The difference to the :option:`--exclude` option is, that this option can be
+ used to selectively add individual patterns without overriding the default
+ list entirely.
+
+ Command-line example:
+
+ .. prompt:: bash
+
+ flake8 --extend-exclude=legacy/,vendor/ dir/
+
+ This **can** be specified in config files.
+
+ Example config file usage:
+
+ .. code-block:: ini
+
+ extend-exclude =
+ legacy/,
+ vendor/
+ extend-exclude = legacy/,vendor/
+
+
.. option:: --filename=<patterns>
:ref:`Go back to index <top>`