The PyPI package for the Python HID library used here is called `hid`
(https://pypi.org/project/hid/), but the docs called it "pyhidapi" while
linking to the `hid` package page. There is also a separate, unrelated,
unmaintained package literally named `pyhidapi` on PyPI, so a reader
following the doc text as written can end up installing the wrong package.
Update the library list and prose to say `hid`, and add a short tip
covering the install/import command and calling out the package to avoid.
Fixes#26047
* Enhance tap-hold docs.
* Minor edits.
* Move note on Quick Tap to a sub bullet for visibility.
Co-authored-by: Drashna Jaelre <drashna@live.com>
---------
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Explain how to use STORE_SETUPS and PRINT_SETUPS
I found the instructions a little terse, but managed.
This also adds a note about PRINT_SETUPS reporting random numbers if STORE_SETUPS hasn't been used.
* Remove line breaks
Existing docs seem to use a mix of hard line breaks at sentence
ends, or 80 chars-ish, versus no line breaks in paragraphs.
* Suggestion during review
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
---------
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
* Show how to flip semicolon and colon
* Apply whitespace suggestions from code review
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Match line-wrapping
Co-authored-by: Joel Challis <git@zvecr.com>
---------
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
* Use less tap dance memory.
Use dynamically allocated sparse array for tap dance state, dynamically allocate tap dance state when needed and free it when the tap dance is done.
* new approach
* Use null, check for null
* Reformat with docker
* Use uint8 with idx rather than uint16 with keycode in state
* fix accidental change
* reformat
* Add null check
* add documentation tip suggested by tzarc
* Only allow tap dance state allocation on key down, not on key up
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* Only allow tap dance allocation on key down, not on key up
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* add user action required section
---------
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* docs: fix misspellings
* docs: do line breaks with HTML instead of spaces
To remove trailing spaces and to avoid breaking things, line breaks can
be done with the HTML br tag.
yi chen
Alexis "Horgix" Chotard
Pascal Getreuer
QMK Bot
Yoichi NAKAYAMA
Konstantin Đorđević
Scott Lamb
Peter Cock
HorrorTroll
Joel Challis
tyler
Stephen Ostermiller
ploopyco
Chaser Huang
James Young
Boudewijn van Groos
François Magimel
Andrew Cooney
timovp
Dasky
luroc
Nick Brassel
art-was-here
Drashna Jaelre
eynsai
ClownFish
フィルターペーパー
Anthony Abruzzini
Will Spooner