diff options
| author | Oleg Broytman <phd@phdru.name> | 2015-02-16 07:31:22 +0300 |
|---|---|---|
| committer | Oleg Broytman <phd@phdru.name> | 2015-02-16 07:32:17 +0300 |
| commit | 836d66a11f4f8791e9f98d83ba77994d43534b80 (patch) | |
| tree | ef974995ee66f795515f32ad6e2d7528d1512527 /docs | |
| parent | d03b5269130403d064a80d4a2b779d7e685d273b (diff) | |
| download | flake8-836d66a11f4f8791e9f98d83ba77994d43534b80.tar.gz | |
Document configuration file settings
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vcs.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/vcs.rst b/docs/vcs.rst index b473616..df56b39 100644 --- a/docs/vcs.rst +++ b/docs/vcs.rst @@ -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 the ``.git/hooks`` directory. -You can control the behavior of the pre-commit hook using environment -variables: +You can control the behavior of the pre-commit hook using configuration file +settings or environment variables: -``FLAKE8_COMPLEXITY`` +``flake8.complexity`` or ``FLAKE8_COMPLEXITY`` Any value > 0 enables complexity checking with McCabe. (defaults to 10) -``FLAKE8_STRICT`` +``flake8.strict`` or ``FLAKE8_STRICT`` If True, this causes the commit to fail in case of any errors at all. (defaults to False) -``FLAKE8_IGNORE`` +``flake8.ignore`` or ``FLAKE8_IGNORE`` Comma-separated list of errors and warnings to ignore. (defaults to empty) -``FLAKE8_LAZY`` +``flake8.lazy`` or ``FLAKE8_LAZY`` If True, also scans those files not added to the index before commit. (defaults to False) |
