summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDasky <32983009+daskygit@users.noreply.github.com>2021-09-22 00:40:19 +0100
committerGitHub <noreply@github.com>2021-09-21 16:40:19 -0700
commit45f88af4a12938072f58d89769145c46a30fb38c (patch)
treed7993f7bc01bd9eac5a7d6c5dc7dafb43f49d5df
parentbb754069e95237bec69cc23845e2515eea5f33e4 (diff)
downloadqmk_firmware-45f88af4a12938072f58d89769145c46a30fb38c.tar.gz
qmk_firmware-45f88af4a12938072f58d89769145c46a30fb38c.zip
[Docs] update suspend_*_user examples (#14542)
-rw-r--r--docs/custom_quantum_functions.md4
-rw-r--r--docs/ja/custom_quantum_functions.md4
-rw-r--r--docs/zh-cn/custom_quantum_functions.md4
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index b0ed0f588d..463366ff76 100644
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@@ -214,11 +214,11 @@ This is controlled by two functions: `suspend_power_down_*` and `suspend_wakeup_
```c
void suspend_power_down_user(void) {
- rgb_matrix_set_suspend_state(true);
+ // code will run multiple times while keyboard is suspended
}
void suspend_wakeup_init_user(void) {
- rgb_matrix_set_suspend_state(false);
+ // code will run on keyboard wakeup
}
```
diff --git a/docs/ja/custom_quantum_functions.md b/docs/ja/custom_quantum_functions.md
index c348f85566..bd3f15a5fd 100644
--- a/docs/ja/custom_quantum_functions.md
+++ b/docs/ja/custom_quantum_functions.md
@@ -211,11 +211,11 @@ void keyboard_post_init_user(void) {
```c
void suspend_power_down_user(void) {
- rgb_matrix_set_suspend_state(true);
+ // code will run multiple times while keyboard is suspended
}
void suspend_wakeup_init_user(void) {
- rgb_matrix_set_suspend_state(false);
+ // code will run on keyboard wakeup
}
```
diff --git a/docs/zh-cn/custom_quantum_functions.md b/docs/zh-cn/custom_quantum_functions.md
index 44cb5cf76d..1ae996e392 100644
--- a/docs/zh-cn/custom_quantum_functions.md
+++ b/docs/zh-cn/custom_quantum_functions.md
@@ -275,11 +275,11 @@ void keyboard_post_init_user(void) {
```c
void suspend_power_down_user(void) {
- rgb_matrix_set_suspend_state(true);
+ // code will run multiple times while keyboard is suspended
}
void suspend_wakeup_init_user(void) {
- rgb_matrix_set_suspend_state(false);
+ // code will run on keyboard wakeup
}
```