]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Minor grammar and filename fixes in docs (#7559)
authorosjuga <43299093+osjuga@users.noreply.github.com>
Sat, 7 Dec 2019 12:19:18 +0000 (07:19 -0500)
committerfauxpark <fauxpark@gmail.com>
Sat, 7 Dec 2019 12:19:18 +0000 (23:19 +1100)
Grammar in coding_conventions_c.md and coding_conventions_python.md

`rule.mk` to `rules.mk` in feature_haptic_feedback.md and feature_rgb_matrix.md

docs/coding_conventions_c.md
docs/coding_conventions_python.md
docs/feature_haptic_feedback.md
docs/feature_rgb_matrix.md

index 08994bfbb74606594f6b4c7ef1961d835926b3e4..16e28b288493b5460b2b4f3ddb18a8e3567af75c 100644 (file)
@@ -14,7 +14,7 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely
   * Think of them as a story describing the feature
   * Use them liberally to explain why particular decisions were made.
   * Do not write obvious comments
-  * If you not sure if a comment is obvious, go ahead and include it.
+  * If you're not sure if a comment is obvious, go ahead and include it.
 * In general we don't wrap lines, they can be as long as needed. If you do choose to wrap lines please do not wrap any wider than 76 columns.
 * We use `#pragma once` at the start of header files rather than old-style include guards (`#ifndef THIS_FILE_H`, `#define THIS_FILE_H`, ..., `#endif`)
 * We accept both forms of preprocessor if's: `#ifdef DEFINED` and `#if defined(DEFINED)`
index 694aa38cfc21f9f38e52a2db264ea8d4f380d695..9dd95e4b731083411582fef6f25fa9a4d7b2b569 100644 (file)
@@ -8,7 +8,7 @@ Most of our style follows PEP8 with some local modifications to make things less
   * Think of them as a story describing the feature
   * Use them liberally to explain why particular decisions were made.
   * Do not write obvious comments
-  * If you not sure if a comment is obvious, go ahead and include it.
+  * If you're not sure if a comment is obvious, go ahead and include it.
 * We require useful docstrings for all functions.
 * In general we don't wrap lines, they can be as long as needed. If you do choose to wrap lines please do not wrap any wider than 76 columns.
 * Some of our practices conflict with the wider python community to make our codebase more approachable to non-pythonistas.
index 2273633227336cbfcf79c7bce931c075617cb050..ff7337a51a44d01f0b5d544d70a9e338de3ebd29 100644 (file)
@@ -2,7 +2,7 @@
 
 ## Haptic feedback rules.mk options
 
-The following options are currently available for haptic feedback in `rule.mk`:
+The following options are currently available for haptic feedback in `rules.mk`:
 
 `HAPTIC_ENABLE += DRV2605L`
 
index 5b834a99d5fc883908b1b7ac53c1d0d15099e202..5695acc508125f323228ddfae470c534fbef4a8b 100644 (file)
@@ -286,7 +286,7 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con
 
 ## Custom RGB Matrix Effects
 
-By setting `RGB_MATRIX_CUSTOM_USER` (and/or `RGB_MATRIX_CUSTOM_KB`) in `rule.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files.
+By setting `RGB_MATRIX_CUSTOM_USER` (and/or `RGB_MATRIX_CUSTOM_KB`) in `rules.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files.
 
 To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks something like this: