diff options
author | kiilerix <[email protected]> | 2022-03-05 05:58:50 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2022-03-05 15:58:50 +1100 |
commit | da6d6ce2e1f266892badbd42fb8c6735e61e784f (patch) | |
tree | b5e64da206540e60e01a0fc262c13fa5353d68f3 /docs/cli_development.md | |
parent | 82dd84e257db8e5fd1eb33c152a0026ee5bee7fe (diff) | |
download | qmk_firmware-da6d6ce2e1f266892badbd42fb8c6735e61e784f.tar.gz qmk_firmware-da6d6ce2e1f266892badbd42fb8c6735e61e784f.zip |
Some docs improvements (#15845)
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't
It is not strictly necessary to use LAYOUT macros in keyboard.c, but it
is a convenient abstraction of hardware internals, allowing focus on the
physical keyboard layout.
From the C source point of view LAYOUT is macro with a parameter list,
which expands to a array of rows that each is an array with a keyboard
scancode for each column. A macro parameter list is not an array, and
even less a single array.
Perhaps no big deal, but also no reason to give incorrect hints.
* docs: update "Understanding QMK's Code" to current code structure introduced in 96e2b13d1de
This part of the documentation was no longer correct. I tried updating
it, mainly copy editing and using github links to latest release.
This is not trying to fix all problems, but just trying to fix some
problems while reusing much of the old phrases and structure.
* Update docs to use "qmk format-python"
Diffstat (limited to 'docs/cli_development.md')
-rw-r--r-- | docs/cli_development.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cli_development.md b/docs/cli_development.md index 62be3b3d8c..17370a732a 100644 --- a/docs/cli_development.md +++ b/docs/cli_development.md @@ -188,7 +188,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou # Testing, and Linting, and Formatting (oh my!) -We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `format-py` subcommands to run these tests: +We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `format-python` subcommands to run these tests: ### Testing and Linting @@ -196,7 +196,7 @@ We use nose2, flake8, and yapf to test, lint, and format code. You can use the ` ### Formatting - qmk format-py + qmk format-python ## Formatting Details |