Skip to content

Commit 719e674

Browse files
Fix 4227: Improve documentation for --quiet --check (#4236)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
1 parent e5510af commit 719e674

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050

5151
### Documentation
5252

53+
- Note what happens when `--check` is used with `--quiet` (#4236)
5354
<!-- Major changes to documentation and policies. Small docs changes
5455
don't need a changelog entry. -->
5556

docs/usage_and_configuration/the_basics.md

+3
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ Don't write the files back, just return the status. _Black_ will exit with:
183183
- code 1 if some files would be reformatted; or
184184
- code 123 if there was an internal error
185185

186+
If used in combination with `--quiet` then only the exit code will be returned, unless
187+
there was an internal error.
188+
186189
```console
187190
$ black test.py --check
188191
All done! ✨ 🍰 ✨

0 commit comments

Comments
 (0)