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.

Sign up for GitHub

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

Jump to bottom

[DOC] Missing LED_MATRIX_INDICATOR_SET_VALUE #24890

Open

iamdanielv opened this issue Feb 1, 2025 · 0 comments

Labels

help wanted question

Contributor

iamdanielv commented Feb 1, 2025

Issue Description

The documentation for LED Matrix references "a special macro to help make this easier to use: LED_MATRIX_INDICATOR_SET_VALUE(i, v)."

But I can't find that macro in the current main branch of the code.

It was pretty trivial to write:

#define LED_MATRIX_INDICATOR_SET_VALUE(i, v) \
    if (i >= led_min && i < led_max) {       \
        led_matrix_set_value(i, v);          \
    }

It is confusing to have the documents reference code that doesn't exist.

I suggest to either :

remove the mention of the macro, or
put the macro back in the led_matrix.h file

I can create a PR with the changes if it's ok with the maintainers.

The text was updated successfully, but these errors were encountered:

iamdanielv added help wanted question labels

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