-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor: replace zmk,matrix_transform with zmk,matrix-transform #2102
Conversation
543f684
to
280d612
Compare
I think it may be confusing if the docs say one thing but all the code does something different. Can we check if it works to update the code to use hyphens and then build a user config repo that still uses an underscore when selecting a non-default transform? If we can confirm that it isn't a breaking change and the user config still selects the correct tranform, then we can update all the existing boards/shields to match this new documentation too. |
Sure. Here's what happens when you force n.b. The CI failure is unrelated to my changes:
|
To analyze your results, using |
Correct, as the user config repo commit describes. The 1000+ additional warning lines spewed out during the build action when there are too many elements are a much more obvious tell than having to painstakingly count the number of elements in two inconveniently-formatted devicetree nodes. |
I think best would be to test and confirm that the transform choice was effective, but absent that the build warnings seem like a good sign. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs updates LGTM, thanks for updating the links as well -- they all seem to be live.
(I think it is a good idea in general too, given it is backwards compatible.)
I've done that; I personally use this keymap, which draws on this module (and you're welcome to examine its last build)—but how do you propose I demonstrate the results? The number of nodes in the keymap file isn't modified by the selected transform, and there are no errors or warnings if it technically has too few keys. You can see |
Maybe I missed it, but I didn't know that you had already tested it on a keyboard. Verbal confirmation is enough for me. I guess you could write a unit test but I (personally) wouldn't think that is necessary. |
* While functionally equivalent, the hyphenated form of this property is more consistent with other ZMK properties and adheres to DTS style guidelines. * Additionally, update links to use Zephyr 3.2 documentation instead of 2.5 where appropriate.
* Align codebase with documentation.
7465064
to
b959096
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
This PR intentionally refrains from updating any boards or shields to minimize disruption, as some forks and/or utilities may currently expect/require the underscore form (Keymap Editor being one).