diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-06-14 20:43:00 -0500 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-06-14 20:43:00 -0500 |
| commit | 8bb304877547710e8deef328beddb23a1f6b9975 (patch) | |
| tree | aa3eb0e87176fd2c5326c2ea0fd126214cf12905 /docs/source/user | |
| parent | 8a18cfa4a321218a67c322dcf70fe4d11efb92ca (diff) | |
| download | flake8-8bb304877547710e8deef328beddb23a1f6b9975.tar.gz | |
Add documentation for --install-hook
Diffstat (limited to 'docs/source/user')
| -rw-r--r-- | docs/source/user/options.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/source/user/options.rst b/docs/source/user/options.rst index 9e998ee..69aec6e 100644 --- a/docs/source/user/options.rst +++ b/docs/source/user/options.rst @@ -492,6 +492,28 @@ This **can not** be specified in config files. +.. option:: --install-hook=VERSION_CONTROL_SYSTEM + + Install a hook for your version control system that is executed before + or during commit. + + The available options are: + + - git + - mercurial + + Command-line usage: + + .. prompt:: bash + + flake8 --install-hook=git + flake8 --install-hook=mercurial + + This **can not** be specified in config files. + +Thank you for your contribution to Flake8's documentation. + + .. option:: --jobs=<n> Specify the number of subprocesses that Flake8 will use to run checks in |
