From 45f88af4a12938072f58d89769145c46a30fb38c Mon Sep 17 00:00:00 2001
From: Dasky <32983009+daskygit@users.noreply.github.com>
Date: Wed, 22 Sep 2021 00:40:19 +0100
Subject: [PATCH] [Docs] update suspend_*_user examples (#14542)
---
docs/custom_quantum_functions.md | 4 ++--
docs/ja/custom_quantum_functions.md | 4 ++--
docs/zh-cn/custom_quantum_functions.md | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index b0ed0f588da..463366ff763 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 c348f85566c..bd3f15a5fd2 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 44cb5cf76d0..1ae996e392b 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
}
```