summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-10-28 22:21:24 +1100
committerGitHub <noreply@github.com>2022-10-28 12:21:24 +0100
commit2ff1d852909daaaf94433fab202e7bf94274d67b (patch)
tree71c303898f424b07d387106101fa8302a578db8b /docs
parent7407347be1df69928d27ea9b6a4fe094429f2a55 (diff)
Normalise Autocorrect keycodes (#18893)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_autocorrect.md14
-rw-r--r--docs/keycodes.md10
2 files changed, 17 insertions, 7 deletions
diff --git a/docs/feature_autocorrect.md b/docs/feature_autocorrect.md
index 480131e5fc..e042027c0f 100644
--- a/docs/feature_autocorrect.md
+++ b/docs/feature_autocorrect.md
@@ -22,7 +22,7 @@ AUTOCORRECT_ENABLE = yes
Additionally, you will need a library for autocorrection. A small sample library is included by default, so that you can get up and running right away, but you can provide a customized library.
-By default, autocorrect is disabled. To enable it, you need to use the `AUTOCORRECT_TOGGLE` keycode to enable it. The status is stored in persistent memory, so you shouldn't need to enabled it again.
+By default, autocorrect is disabled. To enable it, you need to use the `AC_TOGG` keycode to enable it. The status is stored in persistent memory, so you shouldn't need to enabled it again.
## Customizing autocorrect library :id=customizing-autocorrect-library
@@ -94,15 +94,15 @@ Occasionally you might actually want to type a typo (for instance, while editing
This works because the autocorrection implementation doesn’t understand hotkeys, so it resets itself whenever a modifier other than shift is held.
-Additionally, you can use the `AUTOCORRECT_TOGGLE` keycode to toggle the on/off status for Autocorrect.
+Additionally, you can use the `AC_TOGG` keycode to toggle the on/off status for Autocorrect.
### Keycodes :id=keycodes
-|Keycode | Short keycode | Description |
-|---------------------|---------------|------------------------------------------------|
-|`AUTOCORRECT_ON` | `CRT_ON` | Turns on the Autocorrect feature. |
-|`AUTOCORRECT_OFF` | `CRT_OFF` | Turns off the Autocorrect feature. |
-|`AUTOCORRECT_TOGGLE` | `CRT_TOG` | Toggles the status of the Autocorrect feature. |
+|Keycode |Aliases |Description |
+|-----------------------|---------|----------------------------------------------|
+|`QK_AUTOCORRECT_ON` |`AC_ON` |Turns on the Autocorrect feature. |
+|`QK_AUTOCORRECT_OFF` |`AC_OFF` |Turns off the Autocorrect feature. |
+|`QK_AUTOCORRECT_TOGGLE`|`AC_TOGG`|Toggles the status of the Autocorrect feature.|
## User Callback Functions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index 0de0ce56b4..4aa54e1c20 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -247,6 +247,16 @@ See also: [Audio](feature_audio.md)
|`MU_TOG` | |Toggles Music Mode |
|`MU_MOD` | |Cycles through the music modes |
+## Autocorrect :id=autocorrect
+
+See also: [Autocorrect](feature_autocorrect.md)
+
+|Key |Aliases |Description |
+|-----------------------|---------|----------------------------------------------|
+|`QK_AUTOCORRECT_ON` |`AC_ON` |Turns on the Autocorrect feature. |
+|`QK_AUTOCORRECT_OFF` |`AC_OFF` |Turns off the Autocorrect feature. |
+|`QK_AUTOCORRECT_TOGGLE`|`AC_TOGG`|Toggles the status of the Autocorrect feature.|
+
## Backlighting :id=backlighting
See also: [Backlighting](feature_backlight.md)