Merge pull request #1590 from akihironitta/issue/1579

Add description of `--check` exit status to help message
PyCQA · Nov 1, 2020 · 33683cd · 33683cd
2 parents 22f4161 + 6282d29
commit 33683cd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/configuration/options.md b/docs/configuration/options.md
@@ -1005,7 +1005,7 @@ Combines all the bare straight imports of the same section in a single line. Won
 
 ## Check
 
-Checks the file for unsorted / unformatted imports and prints them to the command line without modifying the file.
+Checks the file for unsorted / unformatted imports and prints them to the command line without modifying the file. Returns 0 when nothing would change and returns 1 when the file would be reformatted.
 
 **Type:** Bool  
 **Default:** `False`  

diff --git a/isort/main.py b/isort/main.py
@@ -281,7 +281,8 @@ def _build_arg_parser() -> argparse.ArgumentParser:
         action="store_true",
         dest="check",
         help="Checks the file for unsorted / unformatted imports and prints them to the "
-        "command line without modifying the file.",
+        "command line without modifying the file. Returns 0 when nothing would change and "
+        "returns 1 when the file would be reformatted.",
     )
     general_group.add_argument(
         "--ws",