zmk icon indicating copy to clipboard operation
zmk copied to clipboard

fix(docs): corrected mo_tog example on hold-tap page

Open dabell-cc opened this issue 2 years ago • 3 comments

The bindings for the toggle-layer-on-tap/momentary-layer-on-hold example code were backwards, resulting in toggle-on-hold. This also made momentary unachievable.

dabell-cc avatar Aug 02 '22 18:08 dabell-cc

The board/shield checklist is a little confusing. It doesn't seem too relevant to documentation corrections. I did use this example code on my Leeloo board which is where I observed the issue. I've tested the corrected binding properties on that same board.

I did consider renaming tog_mo to mo_tog, which better aligns with the convention of Hold action/Tap action. If that's indeed preferred I can go back and clean up those references.

dabell-cc avatar Aug 02 '22 18:08 dabell-cc

Renaming the example to mo_tog is fine by me; rolls off the tongue a little better for sure. Thanks for catching the typo in the code block, though!

kurtis-lew avatar Aug 03 '22 04:08 kurtis-lew

Renaming the example to mo_tog is fine by me; rolls off the tongue a little better for sure. Thanks for catching the typo in the code block, though!

Righto, I've added those changes in the second commit.

dabell-cc avatar Aug 04 '22 00:08 dabell-cc

@caksoylar Thanks for the changes. Was there anything else needed before this PR gets merged?

dabell-cc avatar Aug 11 '22 18:08 dabell-cc