From da6d6ce2e1f266892badbd42fb8c6735e61e784f Mon Sep 17 00:00:00 2001 From: kiilerix Date: Sat, 5 Mar 2022 05:58:50 +0100 Subject: 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" --- docs/ja/cli_commands.md | 4 ++-- docs/ja/cli_development.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/ja') diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md index 8a661d56ee..b48de077cd 100644 --- a/docs/ja/cli_commands.md +++ b/docs/ja/cli_commands.md @@ -275,14 +275,14 @@ $ qmk kle2json -f kle.txt -f Ψ Wrote out to info.json ``` -## `qmk format-py` +## `qmk format-python` このコマンドは `qmk_firmware` 内の python コードを整形します。 **使用法**: ``` -qmk format-py +qmk format-python ``` ## `qmk pytest` diff --git a/docs/ja/cli_development.md b/docs/ja/cli_development.md index 28cdd91c1e..082bc5dafa 100644 --- a/docs/ja/cli_development.md +++ b/docs/ja/cli_development.md @@ -192,7 +192,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou # テスト、リントおよびフォーマット -nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `format-py` サブコマンドを使うことができます。 +nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `format-python` サブコマンドを使うことができます。 ### テストとリント @@ -200,7 +200,7 @@ nose2、flake8 および yapf を使ってコードをテスト、リントお ### フォーマット - qmk format-py + qmk format-python ## フォーマットの詳細 -- cgit v1.2.3