aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoshua Moses Diamond <josh@windowoffire.com>2020-04-12 02:22:59 -0400
committerGitHub <noreply@github.com>2020-04-12 16:22:59 +1000
commit750179e111dfa35d8023fe9ef785dcbef24f1e55 (patch)
treea0e8d4fee429b952dba6893d590636766060952d /docs
parentf538b2273a4b9126b5dbfb54218dc40df047b249 (diff)
downloadfirmware-750179e111dfa35d8023fe9ef785dcbef24f1e55.tar.gz
firmware-750179e111dfa35d8023fe9ef785dcbef24f1e55.tar.bz2
firmware-750179e111dfa35d8023fe9ef785dcbef24f1e55.zip
Fix a couple of typos that were causing confusion (#8767)
Diffstat (limited to 'docs')
-rw-r--r--docs/ref_functions.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/ref_functions.md b/docs/ref_functions.md
index 708b0be28..57f701d79 100644
--- a/docs/ref_functions.md
+++ b/docs/ref_functions.md
@@ -8,7 +8,7 @@ There are actually separate functions that you can use there, depending on what
### `update_tri_layer(x, y, z)`
-The first is the `update_tri_layer(x, y, z)` function. This function check to see if layers `x` and `y` are both on. If they are both on, then it runs on layer `z`. Otherwise, if both `x` and `y` are not both on (either only one is, or neither is), then it runs off layer `z`.
+The first is the `update_tri_layer(x, y, z)` function. This function check to see if layers `x` and `y` are both on. If they are both on, then it turns on layer `z`. Otherwise, if both `x` and `y` are not both on (either only one is, or neither is), then it turns off layer `z`.
This function is useful if you want to create specific keys that have this functionality, but other layer keycodes won't do this.
@@ -43,7 +43,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
```
### `update_tri_layer_state(state, x, y, z)`
-The other function is `update_tri_layer_state(state, x, y, z)`. This function is meant to be called from they [`layer_state_set_*` functions](custom_quantum_functions.md#layer-change-code). This means that any time that you use a keycode to change the layer, this will be checked. So you could use `LT(layer, kc)` to change the layer and it will trigger the same layer check.
+The other function is `update_tri_layer_state(state, x, y, z)`. This function is meant to be called from the [`layer_state_set_*` functions](custom_quantum_functions.md#layer-change-code). This means that any time that you use a keycode to change the layer, this will be checked. So you could use `LT(layer, kc)` to change the layer and it will trigger the same layer check.
The caveat to this method is that you cannot access the `z` layer without having `x` and `y` layers on, since if you try to activate just layer `z`, it will run this code and turn off layer `z` before you could use it.