From 9b70e53508e844515f2de8841daeaba01e69eb72 Mon Sep 17 00:00:00 2001 From: Chris Ko Date: Sun, 19 Apr 2020 18:04:26 -0400 Subject: [PATCH] [Docs] Fixed minor typos (#8860) --- docs/syllabus.md | 10 +++++----- docs/tap_hold.md | 4 ++-- tmk_core/common/action.c | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/syllabus.md b/docs/syllabus.md index 239466b791..ec7f66ba78 100644 --- a/docs/syllabus.md +++ b/docs/syllabus.md @@ -4,7 +4,7 @@ This page helps you build up your QMK knowledge by introducing the basics first # Beginning Topics -If you read nothing else you should read the documents in this section. After reading the [Tutorial](newbs.md) you should be able to create a basic keymap, complie it, and flash it to your keyboard. The remaining documents will flesh out your knowledge of these basics. +If you read nothing else you should read the documents in this section. After reading the [Tutorial](newbs.md) you should be able to create a basic keymap, compile it, and flash it to your keyboard. The remaining documents will flesh out your knowledge of these basics. * **Learn How To Use QMK Tools** * [Tutorial](newbs.md) @@ -16,11 +16,11 @@ If you read nothing else you should read the documents in this section. After re * The full list of keycodes you can use. Note that some may require knowledge found in the Intermediate or Advanced Topics. * **Configuring IDEs** - Optional * [Eclipse](other_eclipse.md) - * [VSCode](other_vscode.md) + * [VS Code](other_vscode.md) # Intermediate Topics -These topics start dig into some of the features that QMK supports. You don't have to read all of these documents, but some of the documents in the Advanced Topics section won't make sense if you skip over some of these. +These topics start to dig into some of the features that QMK supports. You don't have to read all of these documents, but some of the documents in the Advanced Topics section won't make sense if you skip over some of these. * **Learn How To Configure Features** @@ -62,9 +62,9 @@ Everything below here requires a lot of foundational knowledge. Besides being ab * [Pointing Devices](feature_pointing_device.md) * **Core Development** * [Coding Conventions](coding_conventions_c.md) - * [Compatible Microcontrolers](compatible_microcontrollers.md) + * [Compatible Microcontrollers](compatible_microcontrollers.md) * [Custom Matrix](custom_matrix.md) - * [Understandnig QMK](understanding_qmk.md) + * [Understanding QMK](understanding_qmk.md) * **CLI Development** * [Coding Conventions](coding_conventions_python.md) * [CLI Development Overview](cli_development.md) diff --git a/docs/tap_hold.md b/docs/tap_hold.md index 1719c0bbe5..a0b648694b 100644 --- a/docs/tap_hold.md +++ b/docs/tap_hold.md @@ -12,7 +12,7 @@ As of [PR#1359](https://github.com/qmk/qmk_firmware/pull/1359/), there is a new #define PERMISSIVE_HOLD ``` -This makes tap and hold keys (like Mod Tap) work better for fast typist, or for high `TAPPING_TERM` settings. +This makes tap and hold keys (like Mod Tap) work better for fast typists, or for high `TAPPING_TERM` settings. If you press a Mod Tap key, tap another key (press and release) and then release the Mod Tap key, all within the tapping term, it will output the "tapping" function for both keys. @@ -35,7 +35,7 @@ To enable this setting, add this to your `config.h`: #define IGNORE_MOD_TAP_INTERRUPT ``` -Similar to Permissive Hold, this alters how the firmware processes input for fast typist. If you press a Mod Tap key, press another key, release the Mod Tap key, and then release the normal key, it would normally output the "tapping" function for both keys. This may not be desirable for rolling combo keys. +Similar to Permissive Hold, this alters how the firmware processes inputs for fast typists. If you press a Mod Tap key, press another key, release the Mod Tap key, and then release the normal key, it would normally output the "tapping" function for both keys. This may not be desirable for rolling combo keys. Setting `Ignore Mod Tap Interrupt` requires holding both keys for the `TAPPING_TERM` to trigger the hold function (the mod). diff --git a/tmk_core/common/action.c b/tmk_core/common/action.c index 27c0abe6fa..e5e9e27052 100644 --- a/tmk_core/common/action.c +++ b/tmk_core/common/action.c @@ -870,7 +870,7 @@ void tap_code(uint8_t code) { /** \brief Adds the given physically pressed modifiers and sends a keyboard report immediately. * - * \param mods A bitfield of modifiers to unregister. + * \param mods A bitfield of modifiers to register. */ void register_mods(uint8_t mods) { if (mods) {