From 9a1fbec5e352bc917e8d9715f108f3c2db3addd7 Mon Sep 17 00:00:00 2001
From: Cem Aksoylar <caksoylar@users.noreply.github.com>
Date: Fri, 26 Jul 2024 14:47:27 -0700
Subject: [PATCH] fix(docs): Fix mod-morph terms from keycodes to bindings
---
docs/docs/behaviors/mod-morph.md | 15 +++++++--------
1 file changed, 7 insertions(+), 8 deletions(-)
diff --git a/docs/docs/behaviors/mod-morph.md b/docs/docs/behaviors/mod-morph.md
index 8949ec2c..f77d7511 100644
--- a/docs/docs/behaviors/mod-morph.md
+++ b/docs/docs/behaviors/mod-morph.md
@@ -5,18 +5,17 @@ sidebar_label: Mod-Morph
## Summary
-The Mod-Morph behavior sends a different keypress, depending on whether a specified modifier is being held during the keypress.
+The mod-morph behavior invokes a different behavior depending on whether any of the specified modifiers are being held during the key press.
-- If you tap the key by itself, the first keycode is sent.
-- If you tap the key while holding the specified modifier, the second keycode is sent.
+- If you tap the key by itself, the first behavior binding is activated.
+- If you tap the key while holding (any of) the specified modifier(s), the second behavior binding is activated.
## Mod-Morph
-The Mod-Morph behavior acts as one of two keycodes, depending on if the required modifier is being held during the keypress.
-
### Configuration
-An example of how to implement the mod-morph "Grave Escape":
+Below is an example of how to implement the mod-morph "Grave Escape". When assigned to a key, pressing the key on its own will send an
+Escape keycode but pressing it while a shift or GUI modifier is held sends the grave `` ` `` keycode instead:
```dts
/ {
@@ -31,7 +30,7 @@ An example of how to implement the mod-morph "Grave Escape":
};
```
-Note that this specific mod-morph exists in ZMK by default using code `&gresc`.
+Note that this specific mod-morph exists in ZMK by default using the binding `&gresc`.
### Behavior Binding
@@ -67,7 +66,7 @@ mods = <(MOD_LGUI|MOD_LSFT|MOD_RGUI|MOD_RSFT)>;
### Advanced Configuration
-`keep-mods`
+#### `keep-mods`
When a modifier specified in `mods` is being held, it won't be sent along with the morphed keycode unless it is also specified in `keep-mods`. By default `keep-mods` equals `0`, which means no modifier specified in `mods` will be sent along with the morphed keycode.