~ruther/qmk_firmware

70c6b183dfa9f08b8bf0d11be2cd5036ebed9ff4 — Albert Y 3 years ago 1a4a278
[Docs] Refactor code examples (#18003)

3 files changed, 33 insertions(+), 31 deletions(-)

M docs/feature_encoders.md
M docs/feature_rgb_matrix.md
M docs/newbs_learn_more_resources.md
M docs/feature_encoders.md => docs/feature_encoders.md +29 -26
@@ 125,34 125,37 @@ Layer conditions can also be used with the callback function like the following:

```c
bool encoder_update_user(uint8_t index, bool clockwise) {
    if (get_highest_layer(layer_state|default_layer_state) > 0) {
        if (index == 0) {
            if (clockwise) {
                tap_code(KC_WH_D);
            } else {
                tap_code(KC_WH_U);
    switch(get_highest_layer(layer_state|default_layer_state)) {
        case 0:
            if (index == 0) {
                if (clockwise) {
                    tap_code(KC_PGDN);
                } else {
                    tap_code(KC_PGUP);
                }
            } else if (index == 1) {
                if (clockwise) {
                    rgb_matrix_increase_speed();
                } else {
                    rgb_matrix_decrease_speed();
                }
            }
        } else if (index == 1) {
            if (clockwise) {
                tap_code_delay(KC_VOLU, 10);
            } else {
                tap_code_delay(KC_VOLD, 10);
            break;
        case 1:
            if (index == 0) {
                if (clockwise) {
                    tap_code(KC_WH_D);
                } else {
                    tap_code(KC_WH_U);
                }
            } else if (index == 1) {
                if (clockwise) {
                    tap_code_delay(KC_VOLU, 10);
                } else {
                    tap_code_delay(KC_VOLD, 10);
                }
            }
        }
    } else {  /* Layer 0 */
        if (index == 0) {
            if (clockwise) {
                tap_code(KC_PGDN);
            } else {
                tap_code(KC_PGUP);
            }
        } else if (index == 1) {
            if (clockwise) {
                rgb_matrix_increase_speed();
            } else {
                rgb_matrix_decrease_speed();
            }
        }
            break;
    }
    return false;
}

M docs/feature_rgb_matrix.md => docs/feature_rgb_matrix.md +4 -4
@@ 889,15 889,15 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
}
```

Layer indicator on all flagged keys:
Layer indicator on all keys:
```c
void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
    for (uint8_t i = led_min; i <= led_max; i++) {
        switch(get_highest_layer(layer_state|default_layer_state)) {
            case RAISE:
            case 2:
                rgb_matrix_set_color(i, RGB_BLUE);
                break;
            case LOWER:
            case 1:
                rgb_matrix_set_color(i, RGB_YELLOW);
                break;
            default:


@@ 907,7 907,7 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
}
```

Layer indicator with only configured keys:
Layer indicator only on keys with configured keycodes:
```c
void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
    if (get_highest_layer(layer_state) > 0) {

M docs/newbs_learn_more_resources.md => docs/newbs_learn_more_resources.md +0 -1
@@ 20,7 20,6 @@ Not sure which text editor to use?
Editors specifically made for code:
* [Sublime Text](https://www.sublimetext.com/)
* [VS Code](https://code.visualstudio.com/)
* [Atom](https://atom.io/)

### Git resources