qmk_firmware

commit 78c4907f34cc7936299ae5cc78460cb45f286e56
parent dc5234746148adf06ef399a50a8ecd1b3f5e999d
Author: mmccoyd <mmccoyd@users.noreply.github.com>
Date:   Mon,  3 Oct 2022 19:17:08 -0700

[Docs] Clarify CAPS_WORD behaviors (#18137)

Co-authored-by: precondition <57645186+precondition@users.noreply.github.com>
Co-authored-by: mmccoyd <mmccoyd@cs.berkley.edu>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat:
M
docs/feature_caps_word.md
 | 
5
++++-

1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/feature_caps_word.md b/docs/feature_caps_word.md
@@ -4,7 +4,10 @@ It is often useful to type a single word in all capitals, for instance
 abbreviations like "QMK", or in code, identifiers like `KC_SPC`. "Caps Word" is
 a modern alternative to Caps Lock:
 
-* Letters are capitalized while active, and Caps Word automatically disables
+* While active, letters are capitalized and `-` becomes `_`. The `_` makes it easier
+  to type constant names (eg 'PROGRAM\_CONSTANTS').
+
+* Caps Word automatically disables
   itself at the end of the word. That is, it stops by default once a space or
   any key other than `KC_A`--`KC_Z`, `KC_0`--`KC_9`, `KC_MINS`, `KC_UNDS`,
   `KC_DELETE`, or `KC_BACKSPACE` is pressed. Caps Word also disables itself if