diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2021-07-23 21:41:33 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-23 21:41:33 +0100 |
| commit | fdcea0633657fba4cebcef45eee2f103d162e28c (patch) | |
| tree | 6d547e2154fa55aea125bc6fc08420c18c8f232a /docs/ja | |
| parent | 164a74a078722cc488526c0c8fcbc4e1b54a5780 (diff) | |
| download | qmk_firmware-fdcea0633657fba4cebcef45eee2f103d162e28c.tar.gz qmk_firmware-fdcea0633657fba4cebcef45eee2f103d162e28c.zip | |
CLI/Docs: Fix the format commands' name (#13668)
PR #13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
Diffstat (limited to 'docs/ja')
| -rw-r--r-- | docs/ja/cli_commands.md | 14 | ||||
| -rw-r--r-- | docs/ja/cli_development.md | 4 |
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md index 81cb03cfe..35937dbbc 100644 --- a/docs/ja/cli_commands.md +++ b/docs/ja/cli_commands.md | |||
| @@ -211,7 +211,7 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] | |||
| 211 | 211 | ||
| 212 | # 開発者用コマンド | 212 | # 開発者用コマンド |
| 213 | 213 | ||
| 214 | ## `qmk cformat` | 214 | ## `qmk format-c` |
| 215 | 215 | ||
| 216 | このコマンドは clang-format を使って C コードを整形します。 | 216 | このコマンドは clang-format を使って C コードを整形します。 |
| 217 | 217 | ||
| @@ -222,25 +222,25 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] | |||
| 222 | **指定したファイルに対する使い方**: | 222 | **指定したファイルに対する使い方**: |
| 223 | 223 | ||
| 224 | ``` | 224 | ``` |
| 225 | qmk cformat [file1] [file2] [...] [fileN] | 225 | qmk format-c [file1] [file2] [...] [fileN] |
| 226 | ``` | 226 | ``` |
| 227 | 227 | ||
| 228 | **全てのコアファイルに対する使い方**: | 228 | **全てのコアファイルに対する使い方**: |
| 229 | 229 | ||
| 230 | ``` | 230 | ``` |
| 231 | qmk cformat -a | 231 | qmk format-c -a |
| 232 | ``` | 232 | ``` |
| 233 | 233 | ||
| 234 | **origin/master で変更されたファイルのみに対する使い方**: | 234 | **origin/master で変更されたファイルのみに対する使い方**: |
| 235 | 235 | ||
| 236 | ``` | 236 | ``` |
| 237 | qmk cformat | 237 | qmk format-c |
| 238 | ``` | 238 | ``` |
| 239 | 239 | ||
| 240 | **branch_name で変更されたファイルのみに対する使い方**: | 240 | **branch_name で変更されたファイルのみに対する使い方**: |
| 241 | 241 | ||
| 242 | ``` | 242 | ``` |
| 243 | qmk cformat -b branch_name | 243 | qmk format-c -b branch_name |
| 244 | ``` | 244 | ``` |
| 245 | 245 | ||
| 246 | ## `qmk docs` | 246 | ## `qmk docs` |
| @@ -275,14 +275,14 @@ $ qmk kle2json -f kle.txt -f | |||
| 275 | Ψ Wrote out to info.json | 275 | Ψ Wrote out to info.json |
| 276 | ``` | 276 | ``` |
| 277 | 277 | ||
| 278 | ## `qmk pyformat` | 278 | ## `qmk format-py` |
| 279 | 279 | ||
| 280 | このコマンドは `qmk_firmware` 内の python コードを整形します。 | 280 | このコマンドは `qmk_firmware` 内の python コードを整形します。 |
| 281 | 281 | ||
| 282 | **使用法**: | 282 | **使用法**: |
| 283 | 283 | ||
| 284 | ``` | 284 | ``` |
| 285 | qmk pyformat | 285 | qmk format-py |
| 286 | ``` | 286 | ``` |
| 287 | 287 | ||
| 288 | ## `qmk pytest` | 288 | ## `qmk pytest` |
diff --git a/docs/ja/cli_development.md b/docs/ja/cli_development.md index 47262213a..28cdd91c1 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 | |||
| 192 | 192 | ||
| 193 | # テスト、リントおよびフォーマット | 193 | # テスト、リントおよびフォーマット |
| 194 | 194 | ||
| 195 | nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `pyformat` サブコマンドを使うことができます。 | 195 | nose2、flake8 および yapf を使ってコードをテスト、リントおよびフォーマットします。これらのテストを実行するために `pytest` と `format-py` サブコマンドを使うことができます。 |
| 196 | 196 | ||
| 197 | ### テストとリント | 197 | ### テストとリント |
| 198 | 198 | ||
| @@ -200,7 +200,7 @@ nose2、flake8 および yapf を使ってコードをテスト、リントお | |||
| 200 | 200 | ||
| 201 | ### フォーマット | 201 | ### フォーマット |
| 202 | 202 | ||
| 203 | qmk pyformat | 203 | qmk format-py |
| 204 | 204 | ||
| 205 | ## フォーマットの詳細 | 205 | ## フォーマットの詳細 |
| 206 | 206 | ||
