From e70739032f2d5be6ae7e16251f7ee953260ff716 Mon Sep 17 00:00:00 2001 From: Nick Coutsos Date: Mon, 26 Jun 2023 17:23:43 -0400 Subject: [PATCH] feat(docs): Clarify use of MACRO_PLACEHOLDER with modifiers --- docs/docs/behaviors/macros.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/behaviors/macros.md b/docs/docs/behaviors/macros.md index 40c333a9..42f018a9 100644 --- a/docs/docs/behaviors/macros.md +++ b/docs/docs/behaviors/macros.md @@ -99,6 +99,10 @@ bindings Because `kp` takes one parameter, you can't simply make the second entry `<&kp>` in the `bindings` list. Whatever value you do pass in will be replaced when the macro is triggered, so you can put _any_ value there, e.g. `0`, `A` keycode, etc. To make it very obvious that the parameter there is not actually going to be used, you can use `MACRO_PLACEHOLDER` which is simply an alias for `0`. +:::note +This isn't a find-and-replace, the behavior is being triggered with the parameter supplied to the macro. To apply a modifier, for example, instead of using `&kp LS(MACRO_PLACEHOLDER)` you would need additional bindings like `<&kt LSHFT>, <&kp MACRO_PLACEHOLDER>, <&kt LSHFT>`. +::: + The available parameter controls are: - `¯o_param_1to1` - pass the first parameter of the macro into the first parameter of the next behavior in the `bindings` list.