summaryrefslogtreecommitdiffstats
path: root/docs/feature_swap_hands.md
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2021-11-29 16:23:37 +0800
committerGitHub <noreply@github.com>2021-11-29 00:23:37 -0800
commitd8324e8a9c41c23b281b9d41a38ddbd4c015ddb4 (patch)
tree22f9aee3df1c8e95dbb55912b86e7a6a547d4dbc /docs/feature_swap_hands.md
parentf9e21a654cc97b14ad2f0d9e9f47bfc1881e099e (diff)
Document swap-hands tap-toggle feature (#15229)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: filterpaper <filterpaper@localhost>
Diffstat (limited to 'docs/feature_swap_hands.md')
-rw-r--r--docs/feature_swap_hands.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md
index b0239bb802..654108ae70 100644
--- a/docs/feature_swap_hands.md
+++ b/docs/feature_swap_hands.md
@@ -27,5 +27,7 @@ Note that the array indices are reversed same as the matrix and the values are o
|`SH_MON` |Swaps hands when pressed, returns to normal when released (momentary). |
|`SH_MOFF` |Momentarily turns off swap. |
|`SH_TG` |Toggles swap on and off with every key press. |
-|`SH_TT` |Toggles with a tap; momentary when held. |
+|`SH_TT` |Momentary swap when held, toggles with repeated taps (see below). |
|`SH_OS` |One shot swap hands: toggles while pressed or until next key press. |
+
+`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md?id=switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`.