Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
qmk-bot committed Jan 8, 2025
2 parents 1cc42e8 + 95c74b6 commit 8247f9e
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
4 changes: 3 additions & 1 deletion docs/feature_macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ If yes, we send the string `"QMK is the best thing ever!"` to the computer via t
We return `true` to indicate to the caller that the key press we just processed should continue to be processed as normal (as we didn't replace or alter the functionality).
Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
?>It is recommended to use the SAFE_RANGE macro as per [Customizing Functionality](custom_quantum_functions).
::: tip
It is recommended to use the SAFE_RANGE macro as per [Customizing Functionality](custom_quantum_functions).
:::
You might want to add more than one macro.
You can do that by adding another keycode and adding another case to the switch statement, like so:
Expand Down
5 changes: 3 additions & 2 deletions docs/feature_userspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,9 @@ Additionally, `config.h` here will be processed like the same file in your keyma

The reason for this, is that `<name>.h` won't be added in time to add settings (such as `#define TAPPING_TERM 100`), and including the `<name.h>` file in any `config.h` files will result in compile issues.

!>You should use the `config.h` for [configuration options](config_options), and the `<name>.h` file for user or keymap specific settings (such as the enum for layer or keycodes)

::: warning
You should use the `config.h` for [configuration options](config_options), and the `<name>.h` file for user or keymap specific settings (such as the enum for layer or keycodes)
:::

## Readme (`readme.md`)

Expand Down
4 changes: 3 additions & 1 deletion docs/features/mouse_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,9 @@ When additional overlapping mouse key is pressed, the mouse cursor will continue
|`MOUSEKEY_OVERLAP_WHEEL_DELTA`|`MOUSEKEY_WHEEL_DELTA`|Step size of reset mouse wheel acceleration |
|`MOUSEKEY_OVERLAP_INTERVAL` |`MOUSEKEY_INTERVAL` |Reset time between cursor movements in milliseconds (Kinetic mode only)|

?> This feature will not be applied on Inertial mode
::: tip
This feature will not be applied on Inertial mode
:::

## Use with PS/2 Mouse and Pointing Device

Expand Down
2 changes: 1 addition & 1 deletion docs/mod_tap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Mod-Tap key `MT(mod, kc)` acts like a modifier when held, and a regular keycode when tapped. In other words, you can have a key that sends Escape when you tap it, but functions as a Control or Shift key when you hold it down.

The modifiers this keycode and `OSM()` accept are prefixed with `MOD_`, not `KC_`:
The modifiers (`mod`) argument to the `MT()` macro are prefixed with `MOD_`, not `KC_`:

|Modifier |Description |
|----------|----------------------------------------|
Expand Down

0 comments on commit 8247f9e

Please sign in to comment.