diff options
| author | Michael van Eerd <michael@cache.works> | 2021-04-15 10:31:07 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-15 03:31:07 -0500 |
| commit | fadb50867147c935b912b2afbfebd9734ef00ccb (patch) | |
| tree | 29f4059417694663774f5bbe506edc86a76d057c | |
| parent | 3893d50e13c0ed8bbe93e7f529c7403dc89b4752 (diff) | |
fix(docs) omit layers -1 example, clarify it defaults when omitted (#757)
* fix(docs) omit layers -1 example, clarify
* comment, simplify description
* remove 'the'
| -rw-r--r-- | docs/docs/features/combos.md | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/docs/docs/features/combos.md b/docs/docs/features/combos.md index 653fc6e..1a19cfe 100644 --- a/docs/docs/features/combos.md +++ b/docs/docs/features/combos.md @@ -18,7 +18,6 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod timeout-ms = <50>; key-positions = <0 1>; bindings = <&kp ESC>; - layers = <-1>; }; }; }; @@ -28,7 +27,7 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod - The `compatible` property should always be `"zmk,combos"` for combos. - `timeout-ms` is the number of milliseconds that all keys of the combo must be pressed. - `key-positions` is an array of key positions. See the info section below about how to figure out the positions on your board. -- `layers = <0 1...>` will allow limiting a combo to specific layers. this is an _optional_ parameter and defaults to `-1` which is global scope. +- `layers = <0 1...>` will allow limiting a combo to specific layers. This is an _optional_ parameter, when omitted it defaults to global scope. - `bindings` is the behavior that is activated when the behavior is pressed. - (advanced) you can specify `slow-release` if you want the combo binding to be released when all key-positions are released. The default is to release the combo as soon as any of the keys in the combo is released. |