Add info about how to return in the docs

qmk · May 13, 2021 · 756e62c · 756e62c
1 parent e544211
commit 756e62c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md
@@ -79,6 +79,8 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
 }
 ```
 
+!> 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.