sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(sequences): clarity in keymap arrays to not look like splats (resolves #576)

Browse Source
This commit is contained in:
Josh Klar 2022-09-07 19:00:35 -07:00 committed by Kyle Brown
parent 87955f7b5f
commit 473d54a83f
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/ptBR/sequences.md
View File

@ -19,7 +19,7 @@ from kmk.handlers.sequences import send_string
WOW = send_string("Wow, KMK is awesome!") WOW = send_string("Wow, KMK is awesome!")
keyboard.keymap = [...WOW,...] keyboard.keymap = [<other keycodes>, WOW, <other keycodes>]
``` ```
## Unicode ## Unicode
@ -54,7 +54,7 @@ from kmk.handlers.sequences import unicode_string_sequence
FLIP = unicode_string_sequence('(ノಠ痊ಠ)ノ彡┻━┻') FLIP = unicode_string_sequence('(ノಠ痊ಠ)ノ彡┻━┻')
keyboard.keymap = [...FLIP,...] keyboard.keymap = [<other keycodes>, FLIP, <other keycodes>]
``` ```
Se, em vez disso, você manter uma tabela de busca de suas sequências (talvez Se, em vez disso, você manter uma tabela de busca de suas sequências (talvez
@ -69,7 +69,7 @@ emoticons = cuss({
'HAND_WAVE': r'👋', 'HAND_WAVE': r'👋',
}) })
keymap = [...emoticons.BEER, emoticons.HAND_WAVE...] keymap = [<other keycodes>, emoticons.BEER, emoticons.HAND_WAVE, <other keycodes>]
``` ```
> Um observador notará que a notação-de-ponto (*dot notation*) é suportada aqui, > Um observador notará que a notação-de-ponto (*dot notation*) é suportada aqui,
@ -89,5 +89,5 @@ TABLE_FLIP = unicode_codepoint_sequence([
"30ce", "5f61", "253b", "2501", "253b", "30ce", "5f61", "253b", "2501", "253b",
]) ])
keyboard.keymap = [...TABLE_FLIP,...] keyboard.keymap = [<other keycodes>, TABLE_FLIP, <other keycodes>]
``` ```

12
docs/sequences.md
View File

@ -17,7 +17,7 @@ from kmk.handlers.sequences import send_string
WOW = send_string("Wow, KMK is awesome!") WOW = send_string("Wow, KMK is awesome!")
keyboard.keymap = [...WOW,...] keyboard.keymap = [<other keycodes>, WOW, <other keycodes>]
``` ```
## Key sequences ## Key sequences
@ -48,7 +48,7 @@ PASTE_WITH_COMMENTARY = simple_key_sequence(
) )
) )
keyboard.keymap = [...PASTE_WITH_COMMENTARY,...] keyboard.keymap = [<other keycodes>, PASTE_WITH_COMMENTARY, <other keycodes>]
``` ```
The above example will type out "look at this: " and then paste the contents of your The above example will type out "look at this: " and then paste the contents of your
@ -78,7 +78,7 @@ COUNTDOWN_TO_PASTE = simple_key_sequence(
) )
) )
keyboard.keymap = [...COUNTDOWN_TO_PASTE,...] keyboard.keymap = [<other keycodes>, COUNTDOWN_TO_PASTE, <other keycodes>]
``` ```
This example will type out the following, waiting one second (1000 ms) between numbers: This example will type out the following, waiting one second (1000 ms) between numbers:
@ -118,7 +118,7 @@ from kmk.handlers.sequences import unicode_string_sequence
FLIP = unicode_string_sequence('(ノಠ痊ಠ)ノ彡┻━┻') FLIP = unicode_string_sequence('(ノಠ痊ಠ)ノ彡┻━┻')
keyboard.keymap = [...FLIP,...] keyboard.keymap = [<other keycodes>, FLIP, <other keycodes>]
``` ```
If you'd rather keep a lookup table of your sequences (perhaps to bind emojis to If you'd rather keep a lookup table of your sequences (perhaps to bind emojis to
@ -132,7 +132,7 @@ emoticons = cuss({
'HAND_WAVE': r'👋', 'HAND_WAVE': r'👋',
}) })
keymap = [...emoticons.BEER, emoticons.HAND_WAVE...] keymap = [<other keycodes>, emoticons.BEER, emoticons.HAND_WAVE, <other keycodes>]
``` ```
> The observant will notice dot-notation is supported here despite feeding in a > The observant will notice dot-notation is supported here despite feeding in a
@ -151,5 +151,5 @@ TABLE_FLIP = unicode_codepoint_sequence([
"30ce", "5f61", "253b", "2501", "253b", "30ce", "5f61", "253b", "2501", "253b",
]) ])
keyboard.keymap = [...TABLE_FLIP,...] keyboard.keymap = [<other keycodes>, TABLE_FLIP, <other keycodes>]
``` ```