summaryrefslogtreecommitdiff
path: root/docs/config_options.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-11-05 21:35:16 -0800
committerJack Humbert <jack.humb@gmail.com>2018-11-06 00:35:16 -0500
commit672926562519c1ee7370b3ef188c11525de326e5 (patch)
treebdcd1bd9bd8892c810586e2db0921a10545238b0 /docs/config_options.md
parent4636f0f623c71f1eda8628cbae4784fe08a8faf7 (diff)
downloadqmk_firmware-672926562519c1ee7370b3ef188c11525de326e5.tar.gz
qmk_firmware-672926562519c1ee7370b3ef188c11525de326e5.zip
Clarify the Mod Tap defines in documentation (#4352)
* Fix up Mod Tap settings keys * Change link names * permissive hold wordsmith Co-Authored-By: drashna <drashna@live.com> * ignore mod tap wordsmithing Co-Authored-By: drashna <drashna@live.com> * grammar fix Co-Authored-By: drashna <drashna@live.com> * wordsmithing Co-Authored-By: drashna <drashna@live.com> * word smithing Co-Authored-By: drashna <drashna@live.com>
Diffstat (limited to 'docs/config_options.md')
-rw-r--r--docs/config_options.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 19861c9d23..c4921c21d7 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -132,14 +132,15 @@ If you define these options you will enable the associated feature, which may in
* `#define TAPPING_TOGGLE 2`
* how many taps before triggering the toggle
* `#define PERMISSIVE_HOLD`
- * makes tap and hold keys work better for fast typers who don't want tapping term set above 500
+ * makes tap and hold keys trigger the hold if another key is pressed before releasing, even if it hasn't hit the `TAPPING_TERM`
* See [Permissive Hold](feature_advanced_keycodes.md#permissive-hold) for details
* `#define IGNORE_MOD_TAP_INTERRUPT`
- * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold
- * See [Mod tap interrupt](feature_advanced_keycodes.md#mod-tap-interrupt) for details
+ * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold, by enforcing the `TAPPING_TERM` for both keys.
+ * See [Mod tap interrupt](feature_advanced_keycodes.md#ignore-mod-tap-interrupt) for details
* `#define TAPPING_FORCE_HOLD`
* makes it possible to use a dual role key as modifier shortly after having been tapped
- * See [Hold after tap](feature_advanced_keycodes.md#hold-after-tap)
+ * See [Hold after tap](feature_advanced_keycodes.md#tapping-force-hold)
+ * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle)
* `#define LEADER_TIMEOUT 300`
* how long before the leader key times out
* `#define ONESHOT_TIMEOUT 300`