From 14f886d03bead5022d1a3ebcc72c75ae1f2b622e Mon Sep 17 00:00:00 2001 From: Jouke Witteveen Date: Sun, 6 Feb 2022 18:36:44 +0100 Subject: [PATCH] [Docs] Address some typos (also in moonlander matrix.c) (#16248) * [Docs] Fix repeated words * [Keyboard] Fix moonlander output The left/right orientation differs from Ergodox EZ. --- docs/api_docs.md | 4 ++-- docs/cli_commands.md | 2 +- docs/feature_tap_dance.md | 2 +- docs/hardware_avr.md | 2 +- docs/ja/cli_commands.md | 2 +- docs/keycodes_us_ansi_shifted.md | 2 +- docs/mod_tap.md | 2 +- docs/other_eclipse.md | 2 +- docs/other_vscode.md | 2 +- docs/zh-cn/cli_commands.md | 2 +- keyboards/moonlander/matrix.c | 4 ++-- keyboards/moonlander/readme.md | 2 +- 12 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api_docs.md b/docs/api_docs.md index 5032dbc87e6..eefb61a54d2 100644 --- a/docs/api_docs.md +++ b/docs/api_docs.md @@ -62,7 +62,7 @@ This shows us that the job has made it through the queue and is currently runnin Once your compile job has finished you'll check the `result` key. The value of this key is a hash containing several key bits of information: -* `firmware_binary_url`: A list of URLs for the the flashable firmware -* `firmware_keymap_url`: A list of URLs for the the `keymap.c` +* `firmware_binary_url`: A list of URLs for the flashable firmware +* `firmware_keymap_url`: A list of URLs for the `keymap.c` * `firmware_source_url`: A list of URLs for the full firmware source code * `output`: The stdout and stderr for this compile job. Errors will be found here. diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 01241b00d83..dfbd4c6a284 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -54,7 +54,7 @@ or in keymap directory ``` $ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak $ qmk compile -Ψ Compiling keymap with make make gh60/satan:colemak +Ψ Compiling keymap with make gh60/satan:colemak ... ``` diff --git a/docs/feature_tap_dance.md b/docs/feature_tap_dance.md index 6edce651cde..c055a9989a4 100644 --- a/docs/feature_tap_dance.md +++ b/docs/feature_tap_dance.md @@ -243,7 +243,7 @@ Now, at the bottom of your `keymap.c` file, you'll need to add the following: * * How to figure out tap dance state: interrupted and pressed. * - * Interrupted: If the state of a dance dance is "interrupted", that means that another key has been hit + * Interrupted: If the state of a dance is "interrupted", that means that another key has been hit * under the tapping term. This is typically indicitive that you are trying to "tap" the key. * * Pressed: Whether or not the key is still being pressed. If this value is true, that means the tapping term diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md index 3d58cdc0558..69aca2cf345 100644 --- a/docs/hardware_avr.md +++ b/docs/hardware_avr.md @@ -1,6 +1,6 @@ # Keyboards with AVR Processors -This page describes the support for for AVR processors in QMK. AVR processors include the atmega32u4, atmega32u2, at90usb1286, and other processors from Atmel Corporation. AVR processors are 8-bit MCUs that are designed to be easy to work with. The most common AVR processors in keyboards have on-board USB and plenty of GPIO for supporting large keyboard matrices. They are the most popular MCU for use in keyboards today. +This page describes the support for AVR processors in QMK. AVR processors include the atmega32u4, atmega32u2, at90usb1286, and other processors from Atmel Corporation. AVR processors are 8-bit MCUs that are designed to be easy to work with. The most common AVR processors in keyboards have on-board USB and plenty of GPIO for supporting large keyboard matrices. They are the most popular MCU for use in keyboards today. If you have not yet you should read the [Keyboard Guidelines](hardware_keyboard_guidelines.md) to get a sense of how keyboards fit into QMK. diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md index 35937dbbcb6..8a661d56ee4 100644 --- a/docs/ja/cli_commands.md +++ b/docs/ja/cli_commands.md @@ -59,7 +59,7 @@ $ qmk compile -km 66_iso ``` $ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak $ qmk compile -Ψ Compiling keymap with make make gh60/satan:colemak +Ψ Compiling keymap with make gh60/satan:colemak ... ``` diff --git a/docs/keycodes_us_ansi_shifted.md b/docs/keycodes_us_ansi_shifted.md index 85dd61759f8..e9749b7b170 100644 --- a/docs/keycodes_us_ansi_shifted.md +++ b/docs/keycodes_us_ansi_shifted.md @@ -8,7 +8,7 @@ Unfortunately, these keycodes cannot be used in Mod-Taps or Layer-Taps, since an Additionally, you may run into issues when using Remote Desktop Connection on Windows. Because these codes send shift very fast, Remote Desktop may miss the codes. -To fix this, open Remote Desktop Connection, click on "Show Options", open the the "Local Resources" tab. In the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly. +To fix this, open Remote Desktop Connection, click on "Show Options", open the "Local Resources" tab. In the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly. ## Keycodes diff --git a/docs/mod_tap.md b/docs/mod_tap.md index dc11b0dea9d..ca3a2752c7c 100644 --- a/docs/mod_tap.md +++ b/docs/mod_tap.md @@ -58,7 +58,7 @@ Currently, the `kc` argument of `MT()` is limited to the [Basic Keycode set](key Expanding this would be complicated, at best. Moving to a 32-bit keycode would solve a lot of this, but would double the amount of space that the keymap matrix uses. And it could potentially cause issues, too. If you need to apply modifiers to your tapped keycode, [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) can be used to accomplish this. You may also run into issues when using Remote Desktop Connection on Windows. Because these keycodes send key events faster than a human, Remote Desktop could miss them. -To fix this, open Remote Desktop Connection, click on "Show Options", open the the "Local Resources" tab, and in the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly. +To fix this, open Remote Desktop Connection, click on "Show Options", open the "Local Resources" tab, and in the keyboard section, change the drop down to "On this Computer". This will fix the issue, and allow the characters to work correctly. It can also be mitigated by increasing [`TAP_CODE_DELAY`](config_options.md#behaviors-that-can-be-configured). ## Intercepting Mod-Taps diff --git a/docs/other_eclipse.md b/docs/other_eclipse.md index 58ab7e295de..de8cdf9b8c9 100644 --- a/docs/other_eclipse.md +++ b/docs/other_eclipse.md @@ -74,7 +74,7 @@ Once both plugins are installed, restart Eclipse as prompted. ## Build Your Keyboard -We will now change the default make target of the the project from `all` to the +We will now change the default make target of the project from `all` to the specific keyboard and keymap combination we are working on, e.g. `kinesis/kint36:stapelberg`. This way, project-wide actions like cleaning and building the project will complete quickly, instead of taking a long time or diff --git a/docs/other_vscode.md b/docs/other_vscode.md index 6af0a6f7b40..aac46c18292 100644 --- a/docs/other_vscode.md +++ b/docs/other_vscode.md @@ -15,7 +15,7 @@ The purpose of this page is to document how to set up VS Code for developing QMK This guide covers how to configure everything needed on Windows and Ubuntu 18.04 # Set up VS Code -Before starting, you will want to make sure that you have all of the build tools set up, and QMK Firmware cloned. Head to the the [Newbs Getting Started Guide](newbs_getting_started.md) to get things set up, if you haven't already. +Before starting, you will want to make sure that you have all of the build tools set up, and QMK Firmware cloned. Head to the [Newbs Getting Started Guide](newbs_getting_started.md) to get things set up, if you haven't already. ## Windows diff --git a/docs/zh-cn/cli_commands.md b/docs/zh-cn/cli_commands.md index 08d1cc7e79a..ed36ed975bb 100644 --- a/docs/zh-cn/cli_commands.md +++ b/docs/zh-cn/cli_commands.md @@ -59,7 +59,7 @@ $ qmk compile -km 66_iso ``` $ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak $ qmk compile -Ψ Compiling keymap with make make gh60/satan:colemak +Ψ Compiling keymap with make gh60/satan:colemak ... ``` diff --git a/keyboards/moonlander/matrix.c b/keyboards/moonlander/matrix.c index 782f131a501..b6bac9515e3 100644 --- a/keyboards/moonlander/matrix.c +++ b/keyboards/moonlander/matrix.c @@ -102,9 +102,9 @@ bool matrix_scan_custom(matrix_row_t current_matrix[]) { print("trying to reset mcp23018\n"); mcp23018_init(); if (!mcp23018_initd) { - print("left side not responding\n"); + print("right side not responding\n"); } else { - print("left side attached\n"); + print("right side attached\n"); #ifdef RGB_MATRIX_ENABLE rgb_matrix_init(); #endif diff --git a/keyboards/moonlander/readme.md b/keyboards/moonlander/readme.md index 0ad2e4775cf..bf80f05569f 100644 --- a/keyboards/moonlander/readme.md +++ b/keyboards/moonlander/readme.md @@ -31,7 +31,7 @@ By default, the Indicator LEDs are used to indicate the layer state for the keyb ### Oryx Configuration -To enable the features from Oryx (ZSA's Configurator), either compile the the `default` keymap, or add `#define ORYX_CONFIGURATOR` to your `config.h` file. +To enable the features from Oryx (ZSA's Configurator), either compile the `default` keymap, or add `#define ORYX_CONFIGURATOR` to your `config.h` file. This enables the front Indicator LEDs, and the `TOGGLE_LAYER_COLOR` keycode. The `TOGGLE_LAYER_COLOR` keycode toggles the customized LED map configured on Oryx.