diff options
| author | mmccoyd <mmccoyd@users.noreply.github.com> | 2022-10-03 19:17:08 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-03 19:17:08 -0700 |
| commit | 78c4907f34cc7936299ae5cc78460cb45f286e56 (patch) | |
| tree | 094b11f1fd5892d7cb8990f6291b38ac37872d5e | |
| parent | dc5234746148adf06ef399a50a8ecd1b3f5e999d (diff) | |
[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>
| -rw-r--r-- | docs/feature_caps_word.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/feature_caps_word.md b/docs/feature_caps_word.md index 283f0f5288..507ea637b2 100644 --- 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 |