update doc accordingly

qmk · Apr 2, 2023 · c56a05e · c56a05e
1 parent 9df48e5
commit c56a05e
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
@@ -102,9 +102,9 @@ Using encoder mapping pumps events through the normal QMK keycode processing pip
 
 ## Callbacks
 
-When not using `ENCODER_MAP_ENABLE = yes`, the callback functions can be inserted into your `<keyboard>.c`:
+?> [**Default Behaviour**](https://github.com/qmk/qmk_firmware/blob/master/quantum/encoder.c#L79-#L98): all encoders installed will function as volume up (`KC_VOLU`) on clockwise rotation and volume down (`KC_VOLD`) on counter-clockwise rotation. If you do not wish to override this, no further configuration is necessary.
 
-?> Those who are adding new keyboard support where encoders are enabled at the keyboard level should include basic encoder functionality at the keyboard level (`<keyboard>.c`) using the `encoder_update_kb()` function, that way it works for QMK Configuator users and exists in general.
+If you would like the alter the default behaviour, and are not using `ENCODER_MAP_ENABLE = yes`, the callback functions can be inserted into your `<keyboard>.c`:
 
 ```c
 bool encoder_update_kb(uint8_t index, bool clockwise) {
@@ -113,9 +113,9 @@ bool encoder_update_kb(uint8_t index, bool clockwise) {
  }
  if (index == 0) { /* First encoder */
  if (clockwise) {
- tap_code_delay(KC_VOLU, 10);
+ tap_code(KC_PGDN);
  } else {
- tap_code_delay(KC_VOLD, 10);
+ tap_code(KC_PGUP);
  }
  } else if (index == 1) { /* Second encoder */
  if (clockwise) {
@@ -134,9 +134,9 @@ or `keymap.c`:
 bool encoder_update_user(uint8_t index, bool clockwise) {
  if (index == 0) { /* First encoder */
  if (clockwise) {
- tap_code_delay(KC_VOLU, 10);
+ tap_code(KC_PGDN);
  } else {
- tap_code_delay(KC_VOLD, 10);
+ tap_code(KC_PGUP);
  }
  } else if (index == 1) { /* Second encoder */
  if (clockwise) {
@@ -149,7 +149,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
 }
 ```
 
-!> If you return `true` in the keymap level `_user` function, it will allow the keyboard level encoder code to run on top of your own. Returning `false` will override the keyboard level function, if setup correctly. This is generally the safest option to avoid confusion.
+!> If you return `true` in the keymap level `_user` function, it will allow the keyboard/core level encoder code to run on top of your own. Returning `false` will override the keyboard level function, if setup correctly. This is generally the safest option to avoid confusion.
 
 ## Hardware