From 9908ed7ecd1bc0c45f0322b959811bd8fd641961 Mon Sep 17 00:00:00 2001
From: Albert Y <76888457+filterpaper@users.noreply.github.com>
Date: Wed, 15 Feb 2023 04:44:18 +0800
Subject: Add swap hands status function (#19831)

Co-authored-by: Drashna Jaelre <drashna@live.com>
---
 docs/feature_swap_hands.md | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'docs/feature_swap_hands.md')

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. |
-- 
cgit v1.2.3