summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-10-22 01:46:10 +1100
committerGitHub <noreply@github.com>2022-10-21 15:46:10 +0100
commit7cbff9d921879ef3c54837cb2ffc455e019f45b4 (patch)
tree03e6555c188204115bafeedd65fb66a5fa03fc5a /docs
parentb33fc349671148bff6f0a60172b53c51e59cda49 (diff)
Deprecate `KC_LOCK` for `QK_LOCK` (#18796)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_key_lock.md6
-rw-r--r--docs/keycodes.md2
2 files changed, 4 insertions, 4 deletions
diff --git a/docs/feature_key_lock.md b/docs/feature_key_lock.md
index 7681394229..d5ad1708c7 100644
--- a/docs/feature_key_lock.md
+++ b/docs/feature_key_lock.md
@@ -2,17 +2,17 @@
Sometimes you may find yourself needing to hold down a specific key for a long period of time. Key Lock holds down the next key you press for you. Press it again, and it will be released.
-Let's say you need to type in ALL CAPS for a few sentences. Hit `KC_LOCK`, and then Shift. Now, Shift will be considered held until you tap it again. You can think of Key Lock as Caps Lock, but supercharged.
+Let's say you need to type in ALL CAPS for a few sentences. Hit `QK_LOCK`, and then Shift. Now, Shift will be considered held until you tap it again. You can think of Key Lock as Caps Lock, but supercharged.
## Usage
-First, enable Key Lock by setting `KEY_LOCK_ENABLE = yes` in your `rules.mk`. Then pick a key in your keymap and assign it the keycode `KC_LOCK`.
+First, enable Key Lock by setting `KEY_LOCK_ENABLE = yes` in your `rules.mk`. Then pick a key in your keymap and assign it the keycode `QK_LOCK`.
## Keycodes
|Keycode |Description |
|---------|--------------------------------------------------------------|
-|`KC_LOCK`|Hold down the next key pressed, until the key is pressed again|
+|`QK_LOCK`|Hold down the next key pressed, until the key is pressed again|
## Caveats
diff --git a/docs/keycodes.md b/docs/keycodes.md
index b0409327c8..5565e0c22c 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -305,7 +305,7 @@ See also: [Key Lock](feature_key_lock.md)
|Key |Description |
|---------|--------------------------------------------------------------|
-|`KC_LOCK`|Hold down the next key pressed, until the key is pressed again|
+|`QK_LOCK`|Hold down the next key pressed, until the key is pressed again|
## Layer Switching :id=layer-switching