Convert Encoder callbacks to be boolean functions (#12805)

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

1 files changed, 6 insertions, 3 deletions

diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
index 4338c85e8..a56f093a3 100644
--- a/docs/feature_encoders.md
+++ b/docs/feature_encoders.md
@@ -53,15 +53,15 @@ If you are using different pinouts for the encoders on each half of a split keyb
 The callback functions can be inserted into your `<keyboard>.c`:
 
 ```c
-void encoder_update_kb(uint8_t index, bool clockwise) {
-    encoder_update_user(index, clockwise);
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+    return encoder_update_user(index, clockwise);
 }
 ```
 
 or `keymap.c`:
 
 ```c
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) { /* First encoder */
         if (clockwise) {
             tap_code(KC_PGDN);
@@ -75,9 +75,12 @@ void encoder_update_user(uint8_t index, bool clockwise) {
             tap_code(KC_UP);
         }
     }
+    return true;
 }
 ```
 
+!> If you return `true`, this will allow the keyboard level code to run, as well.  Returning `false` will override the keyboard level code.  Depending on how the keyboard level function is set up. 
+
 ## Hardware
 
 The A an B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground.