actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
This commit is contained in:
Daniel Krzeminski 2024-03-12 23:15:29 -05:00 committed by GitHub
parent e5510afc06
commit 719e67462c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES.md
View File

@ -50,6 +50,7 @@
### Documentation ### Documentation
- Note what happens when `--check` is used with `--quiet` (#4236)
<!-- Major changes to documentation and policies. Small docs changes <!-- Major changes to documentation and policies. Small docs changes
don't need a changelog entry. --> don't need a changelog entry. -->

3
docs/usage_and_configuration/the_basics.md
View File

@ -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 1 if some files would be reformatted; or
- code 123 if there was an internal error - 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 ```console
$ black test.py --check $ black test.py --check
All done! ✨ 🍰 ✨ All done! ✨ 🍰 ✨