summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2023-02-15 04:44:18 +0800
committerGitHub <noreply@github.com>2023-02-14 12:44:18 -0800
commit9908ed7ecd1bc0c45f0322b959811bd8fd641961 (patch)
tree4ade9b79f3c7f41177d981d017c8953dfb8415dd /docs
parent2cdf99ae950a82e233482347651b7689c4896827 (diff)
Add swap hands status function (#19831)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_swap_hands.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md
index 35131884e1..4d0d554093 100644
--- a/docs/feature_swap_hands.md
+++ b/docs/feature_swap_hands.md
@@ -44,3 +44,9 @@ As an example, if a split keyboard has a single encoder per side, you can swap t
const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS] = { 1, 0 };
#endif
```
+
+### Functions :id=functions
+
+| Function | Description |
+|----------------------|---------------------------------------------|
+| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |