From 719e67462c80574c81a96faa144886de6da84489 Mon Sep 17 00:00:00 2001
From: Daniel Krzeminski <dankrzeminski32@gmail.com>
Date: Tue, 12 Mar 2024 23:15:29 -0500
Subject: [PATCH] Fix 4227: Improve documentation for --quiet --check (#4236)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
---
 CHANGES.md                                 | 1 +
 docs/usage_and_configuration/the_basics.md | 3 +++
 2 files changed, 4 insertions(+)

diff --git a/CHANGES.md b/CHANGES.md
index 1d20a4c9210..e0a034b759b 100644
--- 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
index ea7a2dae5ce..7aa8a644bea 100644
--- 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! ✨ 🍰 ✨