M Makefile => Makefile +1 -1
@@ 264,7 264,7 @@ define PARSE_KEYMAP
# The rest of the rule is the target
# Remove the leading ":" from the target, as it acts as a separator
MAKE_TARGET := $$(patsubst :%,%,$$(RULE))
- # We need to generate an unique indentifer to append to the COMMANDS list
+ # We need to generate an unique identifier to append to the COMMANDS list
CURRENT_KB_UNDER := $$(subst /,_,$$(CURRENT_KB))
COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB_UNDER)_KEYMAP_$$(CURRENT_KM)
# If we are compiling a keyboard without a subproject, we want to display just the name
M builddefs/build_keyboard.mk => builddefs/build_keyboard.mk +1 -1
@@ 236,7 236,7 @@ endif
# that the same keymap may be used on multiple keyboards.
#
# We grab the most top-level include file that we can. That file should
-# use #ifdef statements to include all the neccesary subfolder includes,
+# use #ifdef statements to include all the necessary subfolder includes,
# as described here:
#
# https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
M builddefs/common_rules.mk => builddefs/common_rules.mk +2 -2
@@ 1,7 1,7 @@
# Hey Emacs, this is a -*- makefile -*-
#----------------------------------------------------------------------------
-# Enable vpath seraching for source files only
+# Enable vpath searching for source files only
# Without this, output files, could be read from the wrong .build directories
VPATH_SRC := $(VPATH)
vpath %.c $(VPATH_SRC)
@@ 85,7 85,7 @@ ifeq ($(strip $(DEBUG_ENABLE)),yes)
endif
CXXFLAGS += $(CXXDEFS)
CXXFLAGS += -O$(OPT)
-# to supress "warning: only initialized variables can be placed into program memory area"
+# to suppress "warning: only initialized variables can be placed into program memory area"
CXXFLAGS += -w
CXXFLAGS += -Wall
CXXFLAGS += -Wundef
M docs/api_docs.md => docs/api_docs.md +1 -1
@@ 21,7 21,7 @@ This service is an asynchronous API for compiling custom keymaps. You POST some
}
```
-As you can see the payload describes all aspects of a keyboard necessary to create and generate a firmware. Each layer is a single list of QMK keycodes the same length as the keyboard's `LAYOUT` macro. If a keyboard supports mulitple `LAYOUT` macros you can specify which macro to use.
+As you can see the payload describes all aspects of a keyboard necessary to create and generate a firmware. Each layer is a single list of QMK keycodes the same length as the keyboard's `LAYOUT` macro. If a keyboard supports multiple `LAYOUT` macros you can specify which macro to use.
## Submitting a Compile Job
M docs/cli_commands.md => docs/cli_commands.md +1 -1
@@ 223,7 223,7 @@ Check your environment and report problems only:
## `qmk format-json`
-Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if neccesary.
+Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if necessary.
**Usage**:
M docs/cli_development.md => docs/cli_development.md +1 -1
@@ 162,7 162,7 @@ del(cli.config.<section>.<key>)
## Writing The Configuration File
-The configuration is not written out when it is changed. Most commands do not need to do this. We prefer to have the user change their configuration deliberitely using `qmk config`.
+The configuration is not written out when it is changed. Most commands do not need to do this. We prefer to have the user change their configuration deliberately using `qmk config`.
You can use `cli.save_config()` to write out the configuration.
M docs/coding_conventions_c.md => docs/coding_conventions_c.md +1 -1
@@ 24,7 24,7 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely
* Readability is more important than consistency.
* Follow the file's existing style. If the file is mixed, follow the style that makes sense for the section you are modifying.
* When indenting, keep the hash at the start of the line and add whitespace between `#` and `if`, starting with 4 spaces after the `#`.
- * You can follow the indention level of the surrounding C code, or preprocessor directives can have their own indentation levels. Choose the style that best communicates the intent of your code.
+ * You can follow the indentation level of the surrounding C code, or preprocessor directives can have their own indentation levels. Choose the style that best communicates the intent of your code.
Here is an example for easy reference:
M docs/coding_conventions_python.md => docs/coding_conventions_python.md +2 -2
@@ 2,7 2,7 @@
Most of our style follows PEP8 with some local modifications to make things less nit-picky.
-* We target Python 3.7 for compatability with all supported platforms.
+* We target Python 3.7 for compatibility with all supported platforms.
* We indent using four (4) spaces (soft tabs)
* We encourage liberal use of comments
* Think of them as a story describing the feature
@@ 21,7 21,7 @@ You can use [yapf](https://github.com/google/yapf) to style your code. We provid
We don't have a hard and fast rule for when to use `import ...` vs `from ... import ...`. Understandability and maintainability is our ultimate goal.
-Generally we prefer to import specific function and class names from a module to keep code shorter and easier to understand. Sometimes this results in a name that is ambiguous, and in such cases we prefer to import the module instead. You should avoid using the "as" keyword when importing, unless you are importing a compatability module.
+Generally we prefer to import specific function and class names from a module to keep code shorter and easier to understand. Sometimes this results in a name that is ambiguous, and in such cases we prefer to import the module instead. You should avoid using the "as" keyword when importing, unless you are importing a compatibility module.
Imports should be one line per module. We group import statements together using the standard python rules- system, 3rd party, local.
M docs/config_options.md => docs/config_options.md +1 -1
@@ 195,7 195,7 @@ If you define these options you will enable the associated feature, which may in
* `#define COMBO_TERM 200`
* how long for the Combo keys to be detected. Defaults to `TAPPING_TERM` if not defined.
* `#define COMBO_MUST_HOLD_MODS`
- * Flag for enabling extending timeout on Combos containing modifers
+ * Flag for enabling extending timeout on Combos containing modifiers
* `#define COMBO_MOD_TERM 200`
* Allows for extending COMBO_TERM for mod keys while mid-combo.
* `#define COMBO_MUST_HOLD_PER_COMBO`
M docs/feature_macros.md => docs/feature_macros.md +1 -1
@@ 374,7 374,7 @@ This will clear all keys besides the mods currently pressed.
This macro will register `KC_LALT` and tap `KC_TAB`, then wait for 1000ms. If the key is tapped again, it will send another `KC_TAB`; if there is no tap, `KC_LALT` will be unregistered, thus allowing you to cycle through windows.
```c
-bool is_alt_tab_active = false; // ADD this near the begining of keymap.c
+bool is_alt_tab_active = false; // ADD this near the beginning of keymap.c
uint16_t alt_tab_timer = 0; // we will be using them soon.
enum custom_keycodes { // Make sure have the awesome keycode ready
M docs/feature_oled_driver.md => docs/feature_oled_driver.md +2 -2
@@ 259,12 259,12 @@ void oled_render(void);
void oled_set_cursor(uint8_t col, uint8_t line);
// Advances the cursor to the next page, writing ' ' if true
-// Wraps to the begining when out of bounds
+// Wraps to the beginning when out of bounds
void oled_advance_page(bool clearPageRemainder);
// Moves the cursor forward 1 character length
// Advance page if there is not enough room for the next character
-// Wraps to the begining when out of bounds
+// Wraps to the beginning when out of bounds
void oled_advance_char(void);
// Writes a single character to the buffer at current cursor position
M docs/feature_rgb_matrix.md => docs/feature_rgb_matrix.md +1 -1
@@ 270,7 270,7 @@ Configure the hardware via your `config.h`:
| `ISSI_CONFIGURATION` | (Optional) Configuration for the Configuration Register | |
| `ISSI_GLOBALCURRENT` | (Optional) Configuration for the Global Current Register | 0xFF |
| `ISSI_PULLDOWNUP` | (Optional) Configuration for the Pull Up & Pull Down Register | |
-| `ISSI_TEMP` | (Optional) Configuration for the Tempature Register | |
+| `ISSI_TEMP` | (Optional) Configuration for the Temperature Register | |
| `ISSI_PWM_ENABLE` | (Optional) Configuration for the PWM Enable Register | |
| `ISSI_PWM_SET` | (Optional) Configuration for the PWM Setting Register | |
| `ISSI_SCAL_RED` | (Optional) Configuration for the RED LEDs in Scaling Registers | 0xFF |
M quantum/action_layer.c => quantum/action_layer.c +7 -7
@@ 71,21 71,21 @@ void default_layer_set(layer_state_t state) {
#ifndef NO_ACTION_LAYER
/** \brief Default Layer Or
*
- * Turns on the default layer based on matching bits between specifed layer and existing layer state
+ * Turns on the default layer based on matching bits between specified layer and existing layer state
*/
void default_layer_or(layer_state_t state) {
default_layer_state_set(default_layer_state | state);
}
/** \brief Default Layer And
*
- * Turns on default layer based on matching enabled bits between specifed layer and existing layer state
+ * Turns on default layer based on matching enabled bits between specified layer and existing layer state
*/
void default_layer_and(layer_state_t state) {
default_layer_state_set(default_layer_state & state);
}
/** \brief Default Layer Xor
*
- * Turns on default layer based on non-matching bits between specifed layer and existing layer state
+ * Turns on default layer based on non-matching bits between specified layer and existing layer state
*/
void default_layer_xor(layer_state_t state) {
default_layer_state_set(default_layer_state ^ state);
@@ 115,7 115,7 @@ __attribute__((weak)) layer_state_t layer_state_set_kb(layer_state_t state) {
/** \brief Layer state set
*
- * Sets the layer to match the specifed state (a bitmask)
+ * Sets the layer to match the specified state (a bitmask)
*/
void layer_state_set(layer_state_t state) {
state = layer_state_set_kb(state);
@@ 193,21 193,21 @@ void layer_invert(uint8_t layer) {
/** \brief Layer or
*
- * Turns on layers based on matching bits between specifed layer and existing layer state
+ * Turns on layers based on matching bits between specified layer and existing layer state
*/
void layer_or(layer_state_t state) {
layer_state_set(layer_state | state);
}
/** \brief Layer and
*
- * Turns on layers based on matching enabled bits between specifed layer and existing layer state
+ * Turns on layers based on matching enabled bits between specified layer and existing layer state
*/
void layer_and(layer_state_t state) {
layer_state_set(layer_state & state);
}
/** \brief Layer xor
*
- * Turns on layers based on non-matching bits between specifed layer and existing layer state
+ * Turns on layers based on non-matching bits between specified layer and existing layer state
*/
void layer_xor(layer_state_t state) {
layer_state_set(layer_state ^ state);
M util/docker_build.sh => util/docker_build.sh +2 -2
@@ 19,7 19,7 @@ if [ $# -gt 1 ]; then
exit 1
fi
-# Allow $RUNTIME to be overriden by the user as an environment variable
+# Allow $RUNTIME to be overridden by the user as an environment variable
# Else check if either docker or podman exit and set them as runtime
# if none are found error out
if [ -z "$RUNTIME" ]; then
@@ 36,7 36,7 @@ if [ -z "$RUNTIME" ]; then
exit 2
fi
fi
-
+
# Determine arguments
if [ $# -eq 0 ]; then
M util/docker_cmd.sh => util/docker_cmd.sh +1 -1
@@ 15,7 15,7 @@ for arg; do
fi
done
-# Allow $RUNTIME to be overriden by the user as an environment variable
+# Allow $RUNTIME to be overridden by the user as an environment variable
# Else check if either docker or podman exit and set them as runtime
# if none are found error out
if [ -z "$RUNTIME" ]; then