From: Anthony <anthony.tan@greenworm.net>
Date: Sun, 4 Dec 2016 02:19:25 +0000 (+1100)
Subject: Add note for L/R side bit being ignored
X-Git-Url: https://git.gir.st/tmk_keyboard.git/commitdiff_plain/a499c19cd0fc8aac8d63d4009145b1f7265ee607?hp=-c;ds=sidebyside

Add note for L/R side bit being ignored
---

a499c19cd0fc8aac8d63d4009145b1f7265ee607
diff --git a/tmk_core/doc/keymap.md b/tmk_core/doc/keymap.md
index 30ee5f18..87b72e05 100644
--- a/tmk_core/doc/keymap.md
+++ b/tmk_core/doc/keymap.md
@@ -569,6 +569,7 @@ This registers modifier key(s) simultaneously with layer switching.
 
     ACTION_LAYER_MODS(2, MOD_LSFT | MOD_LALT)
 
+This function can only register left-sided modifiers. The handedness of the modifier (left/right) is an extra bit that is not able to be passed through into the layer system. See: [`common/action_code.h`](../common/action_code.h), the spec for ACT_LAYER_TAP only allows four bits for the mods, whereas the mods themselves require five bits, with the high bit being the left/right handedness.
 
 
 ## 4. Tapping