Add docs for the LAYOUT_* macro to layouts
#3772
Conversation
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the `{}` array form for the keymap layers. I checked the docs, but
this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
|
Most 4x12 ortho keyboards define it "directly" somewhere, like the NIU Mini: qmk_firmware/keyboards/niu_mini/niu_mini.h Lines 19 to 30 in c63d9ee In the case of the Planck however, it currently works a bit differently. Planck standard for a while has been to use a macro named The Planck currently defines For the Planck, that means that a keymap can use As far as your lingo, I see no problems, though someone else may have a different preference. I do have a review comment for you, but it's unrelated to anything you've done here; it's more of a "since you're here, could you fix this thing that was already messed up?" issue. |
|
And subsequently, I learned you can't leave review comments about lines that haven't been edited in the PR. Anyway, on Line 26, could you change (`[a-z0-9_]`)to (`[a-z0-9_]+`)? When I was proof-reading the document, I noticed this regex was wrong. |
|
Thanks! |
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the `{}` array form for the keymap layers. I checked the docs, but
this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
* master: Keymap: Boy_314's Preonic and XD75 Layouts (qmk#3781) Docs: Add docs for the `LAYOUT_*` macro to layouts (qmk#3772) Keyboard: xealous (qmk#3731) Keyboard: Dactyl - Only initialize relevant variables (qmk#3771) Keymap: xtonhasvim updates (qmk#3768) Keymap: Adding keymap to the XD60 (qmk#3767) Putting my ducks in a row: Eagle/Viper V2 into Duck directory (qmk#3766) Putting my ducks in a row: Octagon V1/V2 (qmk#3765) Keymap: Bocaj - Create Userspace and Ergodox Layout (qmk#3750) ISSI31FL3733 driver (qmk#3679) Fixes STM32F303XC timer issue for Planck Rev 6 (qmk#3777)
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the `{}` array form for the keymap layers. I checked the docs, but
this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the `{}` array form for the keymap layers. I checked the docs, but
this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the
{}array form for the keymap layers. I checked the docs, butthis bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
I'm not sure whether my technical lingo is correct here: Is the
LAYOUT_ortho_4x12really a macro? Any other changes?