pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-15 00:44:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document configuration file settings

Browse source
This commit is contained in:
Oleg Broytman 2015-02-16 07:31:22 +03:00
parent d03b526913
commit 836d66a11f
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/vcs.rst
View file

@ -14,21 +14,21 @@ In the case of Git, the hook won't be installed if a custom
``pre-commit`` hook file is already present in ``pre-commit`` hook file is already present in
the ``.git/hooks`` directory. the ``.git/hooks`` directory.
You can control the behavior of the pre-commit hook using environment You can control the behavior of the pre-commit hook using configuration file
variables: settings or environment variables:
``FLAKE8_COMPLEXITY`` ``flake8.complexity`` or ``FLAKE8_COMPLEXITY``
Any value > 0 enables complexity checking with McCabe. (defaults Any value > 0 enables complexity checking with McCabe. (defaults
to 10) to 10)
``FLAKE8_STRICT`` ``flake8.strict`` or ``FLAKE8_STRICT``
If True, this causes the commit to fail in case of any errors at If True, this causes the commit to fail in case of any errors at
all. (defaults to False) all. (defaults to False)
``FLAKE8_IGNORE`` ``flake8.ignore`` or ``FLAKE8_IGNORE``
Comma-separated list of errors and warnings to ignore. (defaults to Comma-separated list of errors and warnings to ignore. (defaults to
empty) empty)
``FLAKE8_LAZY`` ``flake8.lazy`` or ``FLAKE8_LAZY``
If True, also scans those files not added to the index before If True, also scans those files not added to the index before
commit. (defaults to False) commit. (defaults to False)