Skip to content

Commit

Permalink
Fix 4227: Improve documentation for --quiet --check (#4236)
Browse files Browse the repository at this point in the history
Co-authored-by: Jelle Zijlstra <[email protected]>
  • Loading branch information
dankrzeminski32 and JelleZijlstra authored Mar 13, 2024
1 parent e5510af commit 719e674
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. -->

Expand Down
3 changes: 3 additions & 0 deletions docs/usage_and_configuration/the_basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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! ✨ 🍰 ✨
Expand Down

0 comments on commit 719e674

Please sign in to comment.