drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Docs: Add additional clarification to Leader Key documention (#4660)

Browse source 
* 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
This commit is contained in:
Drashna Jael're 2018-12-20 08:58:12 -08:00 • committed by MechMerlin
parent 1586548b4f
commit 6395853148
2 changed files with 76 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/config_options.md
View file

@ -143,6 +143,7 @@ If you define these options you will enable the associated feature, which may in
* Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle)
* `#define LEADER_TIMEOUT 300`
* how long before the leader key times out
* 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.
* `#define LEADER_PER_KEY_TIMING`
* sets the timer for leader key chords to run on each key press rather than overall
* `#define ONESHOT_TIMEOUT 300`