Fix 4227: Improve documentation for --quiet --check (#4236)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
psf · Mar 13, 2024 · 719e674 · 719e674
1 parent e5510af
commit 719e674
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -50,6 +50,7 @@
 
 ### Documentation
 
+- Note what happens when `--check` is used with `--quiet` (#4236)
 <!-- Major changes to documentation and policies. Small docs changes
      don't need a changelog entry. -->
 

diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md
@@ -183,6 +183,9 @@ Don't write the files back, just return the status. _Black_ will exit with:
 - code 1 if some files would be reformatted; or
 - code 123 if there was an internal error
 
+If used in combination with `--quiet` then only the exit code will be returned, unless
+there was an internal error.
+
 ```console
 $ black test.py --check
 All done! ✨ 🍰 ✨