Skip to content

Commit

Permalink
Fix some typos and errors in docs/tap_hold.md
Browse files Browse the repository at this point in the history
Thanks to @precondition for noticing these problems.
  • Loading branch information
sigprof committed Sep 21, 2020
1 parent 7ea8c1e commit 5c3043b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/tap_hold.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ An example of a sequence which is affected by the “permissive hold” mode:
- `KC_L` Up
- `LT(2, KC_A)` Up

Normally, if you do all this within the `TAPPING_TERM` (default: 200ms), this will be registered as `al` by the firmware and host system. With the `PERMISSIVE_HOLD` option enabled, the Layer Tap key is considered as a layer switch if another key is tapped, and the above sequence would be registered as `KC_RHGT` (the mapping of `L` on layer 2).
Normally, if you do all this within the `TAPPING_TERM` (default: 200ms), this will be registered as `al` by the firmware and host system. With the `PERMISSIVE_HOLD` option enabled, the Layer Tap key is considered as a layer switch if another key is tapped, and the above sequence would be registered as `KC_RGHT` (the mapping of `L` on layer 2).

However, this slightly different sequence will not be affected by the “permissive hold” mode:

Expand All @@ -91,10 +91,10 @@ You can then add the following function to your keymap:
bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case LT(1, KC_BSPC):
// Immediately select the tap action when another key is tapped.
// Immediately select the hold action when another key is tapped.
return true;
default:
// Do not select the tap action when another key is tapped.
// Do not select the hold action when another key is tapped.
return false;
}
}
Expand All @@ -119,7 +119,7 @@ An example of a sequence which is affected by the “hold on other key press”
- `LT(2, KC_A)` Up
- `KC_L` Up

Normally, if you do all this within the `TAPPING_TERM` (default: 200ms), this will be registered as `al` by the firmware and host system. With the `HOLD_ON_OTHER_KEY_PRESS` option enabled, the Layer Tap key is considered as a layer switch if another key is pressed, and the above sequence would be registered as `KC_RHGT` (the mapping of `L` on layer 2).
Normally, if you do all this within the `TAPPING_TERM` (default: 200ms), this will be registered as `al` by the firmware and host system. With the `HOLD_ON_OTHER_KEY_PRESS` option enabled, the Layer Tap key is considered as a layer switch if another key is pressed, and the above sequence would be registered as `KC_RGHT` (the mapping of `L` on layer 2).

?> The `HOLD_ON_OTHER_KEY_PRESS` option also affects Mod Tap keys, but this may not be noticeable if you do not also enable the `IGNORE_MOD_TAP_INTERRUPT` option for those keys, because the default handler for Mod Tap keys also considers the “rolling press” sequence like shown above as a modifier hold, not the tap action. If you do not enable `IGNORE_MOD_TAP_INTERRUPT`, the effect of `HOLD_ON_OTHER_KEY_PRESS` on Mod Tap keys would be limited to reducing the delay before the key events are made visible to the host.

Expand All @@ -135,10 +135,10 @@ You can then add the following function to your keymap:
bool get_hold_on_other_key_press(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case LT(1, KC_BSPC):
// Immediately select the tap action when another key is pressed.
// Immediately select the hold action when another key is pressed.
return true;
default:
// Do not select the tap action when another key is pressed.
// Do not select the hold action when another key is pressed.
return false;
}
}
Expand Down

0 comments on commit 5c3043b

Please sign in to comment.