diff options
| author | Nicholas Devenish <ndevenish@gmail.com> | 2020-08-25 16:14:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-25 16:14:36 +0100 |
| commit | 167844cf9ada9fdfc84cc679806a23cca2fe750d (patch) | |
| tree | 1df7e5edceb49b56e71f3dfcc5db83655cd15386 | |
| parent | cf44d6720f27973cdb54a48bbe8b91bae9055821 (diff) | |
| download | isort-167844cf9ada9fdfc84cc679806a23cca2fe750d.tar.gz | |
Fix documentation for skip_file action comment
This was documented as skip-file, whereas the default in settings.py is
skip_file (with an underscore).
| -rw-r--r-- | docs/configuration/action_comments.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/configuration/action_comments.md b/docs/configuration/action_comments.md index ca1edd25..11b1a1a3 100644 --- a/docs/configuration/action_comments.md +++ b/docs/configuration/action_comments.md @@ -3,7 +3,7 @@ The most basic way to configure the flow of isort within a single file is action comments. These comments are picked up and interpreted by the isort parser during parsing. -## isort: skip-file +## isort: skip_file Tells isort to skip the entire file. @@ -11,7 +11,7 @@ Example: ```python # !/bin/python3 -# isort: skip-file +# isort: skip_file import os import sys |