diff options
author | Bendik Samseth <b.samseth@gmail.com> | 2019-02-19 16:18:32 +0100 |
---|---|---|
committer | Bendik Samseth <b.samseth@gmail.com> | 2019-02-19 16:18:32 +0100 |
commit | bb011eb86aa2be9c7659b9b3a9903f72f926a745 (patch) | |
tree | a21d3b341f3870746305135829f87cd484a10693 /README.rst | |
parent | fbe312fd7a427b53d82947294bf023ff08802388 (diff) | |
download | isort-bb011eb86aa2be9c7659b9b3a9903f72f926a745.tar.gz |
Update README.rst with new hook usage.
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -584,10 +584,11 @@ To cause the commit to fail if there are isort errors (strict mode), include the import sys from isort.hooks import git_hook - sys.exit(git_hook(strict=True)) + sys.exit(git_hook(strict=True, modify=True)) If you just want to display warnings, but allow the commit to happen anyway, call ``git_hook`` without -the `strict` parameter. +the `strict` parameter. If you want to display warnings, but not also fix the code, call ``git_hook`` without +the `modify` parameter. Setuptools integration ---------------------- |