Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some docs improvements #15845

Merged
merged 3 commits into from
Mar 5, 2022
Merged

Some docs improvements #15845

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8378f85
docs: clarify in "Keymap Overview" what LAYOUT is and isn't
kiilerix Jan 6, 2022
3cb7bbf
docs: update "Understanding QMK's Code" to current code structure int…
kiilerix Jan 6, 2022
f59f52c
Update docs to use "qmk format-python"
kiilerix Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update docs to use "qmk format-python"
  • Loading branch information
@kiilerix
kiilerix committed Jan 11, 2022
commit f59f52c4e64857cf22f0c13dba30aad7f8660ed0
4 changes: 2 additions & 2 deletions docs/cli_development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,15 +188,15 @@ 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

qmk pytest

### Formatting

qmk format-py
qmk format-python

## Formatting Details

Expand Down
4 changes: 2 additions & 2 deletions docs/ja/cli_commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions docs/ja/cli_development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,15 +192,15 @@ 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` サブコマンドを使うことができます。

### テストとリント

qmk pytest

### フォーマット

qmk format-py
qmk format-python

## フォーマットの詳細

Expand Down