Skip to content

Update documentation of default layers #24945

Open
@dvermd

Description

Issue Description

None of the examples using get_highest_layer in the documentation are using | default_layer_state which is required if you use DF of PDF.
The layer status documentation is at least misleading if not false because unlike layer_state, default_layer is not a variable that can be used in C.
It should be explaining the default_layer_state C variable and that one should use get_highest_layer(layer_state | default_layer_state) to get the right layer.

Maybe the examples in other features could be updated with | default_layer_state.
That will increase the firmware size but how many calls to get_highest_layer will do if it's limited in size ? A note could be added in the troubleshooting section.

Or the other way around, just update the schemas on the Keymap Layer Status page with a note for adding | default_layer_state and a note in troubleshooting

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions