diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-12-20 08:58:12 -0800 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2018-12-20 08:58:12 -0800 |
| commit | 639585314863912480c9967fc38bb2d9418a34ab (patch) | |
| tree | d62dd53e99ba77896309a0736c1e34b4816eaba2 /docs/config_options.md | |
| parent | 1586548b4f45f76d9cd05be4ee9588b3d4b3860e (diff) | |
| download | qmk_firmware-639585314863912480c9967fc38bb2d9418a34ab.tar.gz qmk_firmware-639585314863912480c9967fc38bb2d9418a34ab.zip | |
Docs: Add additional clarification to Leader Key documention (#4660)
* Add clarification for Leader Timeout
* Add additional documentatin to config_options.md
* Add leader_start() and leader_end() documentation
* Add Examples
* Clarify timout
* Remove customization
* Improve docs based on feedback
* Better clarification of features
* Fix example
* Spelling/grammar issue
* Spelling and clarification
Diffstat (limited to 'docs/config_options.md')
| -rw-r--r-- | docs/config_options.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index fb1655e9a..879761a40 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
| @@ -143,6 +143,7 @@ If you define these options you will enable the associated feature, which may in | |||
| 143 | * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle) | 143 | * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle) |
| 144 | * `#define LEADER_TIMEOUT 300` | 144 | * `#define LEADER_TIMEOUT 300` |
| 145 | * how long before the leader key times out | 145 | * how long before the leader key times out |
| 146 | * If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the `LEADER_PER_KEY_TIMING` option, which resets the timeout after each key is tapped. | ||
| 146 | * `#define LEADER_PER_KEY_TIMING` | 147 | * `#define LEADER_PER_KEY_TIMING` |
| 147 | * sets the timer for leader key chords to run on each key press rather than overall | 148 | * sets the timer for leader key chords to run on each key press rather than overall |
| 148 | * `#define ONESHOT_TIMEOUT 300` | 149 | * `#define ONESHOT_TIMEOUT 300` |