summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-12-14 13:46:01 +1100
committerGitHub <noreply@github.com>2022-12-14 13:46:01 +1100
commite2117564c54044c809903627c0061b5a9d129815 (patch)
tree6439e66eac4c362e16aaa65b1f4530598b91828d /docs
parent49b81a9c2b9dca681cf26ced9c1115c2c53f1ba1 (diff)
Leader: remove `qk_` prefix (#19304)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_leader_key.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/feature_leader_key.md b/docs/feature_leader_key.md
index e285d10597..4e7a487be7 100644
--- a/docs/feature_leader_key.md
+++ b/docs/feature_leader_key.md
@@ -93,18 +93,18 @@ While, this may be fine for most, if you want to specify the whole keycode (eg,
## Customization
-The Leader Key feature has some additional customization to how the Leader Key feature works. It has two functions that can be called at certain parts of the process. Namely `leader_start()` and `leader_end()`.
+The Leader Key feature has some additional customization to how the Leader Key feature works. It has two functions that can be called at certain parts of the process. Namely `leader_start_user()` and `leader_end_user()`.
-The `leader_start()` function is called when you tap the `QK_LEAD` key, and the `leader_end()` function is called when either the leader sequence is completed, or the leader timeout is hit.
+The `leader_start_user()` function is called when you tap the `QK_LEAD` key, and the `leader_end_user()` function is called when either the leader sequence is completed, or the leader timeout is hit.
You can add these functions to your code (`keymap.c` usually) to add feedback to the Leader sequences (such as beeping or playing music).
```c
-void leader_start(void) {
+void leader_start_user(void) {
// sequence started
}
-void leader_end(void) {
+void leader_end_user(void) {
// sequence ended (no success/failure detection)
}
```
@@ -139,13 +139,13 @@ void matrix_scan_user(void) {
}
}
-void leader_start(void) {
+void leader_start_user(void) {
#ifdef AUDIO_ENABLE
PLAY_SONG(leader_start);
#endif
}
-void leader_end(void) {
+void leader_end_user(void) {
if (did_leader_succeed) {
#ifdef AUDIO_ENABLE
PLAY_SONG(leader_succeed);