From 756e62cd8c3536b9ca77672967c37fc7245353e1 Mon Sep 17 00:00:00 2001 From: Drashna Jael're Date: Fri, 7 May 2021 23:25:17 -0700 Subject: [PATCH] Add info about how to return in the docs --- docs/feature_encoders.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md index 1ca19568f73f..a56f093a3989 100644 --- 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.