aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_development.md
diff options
context:
space:
mode:
authorQMK Bot <[email protected]>2024-05-30 09:00:58 +0000
committerQMK Bot <[email protected]>2024-05-30 09:00:58 +0000
commit6ca94ae1587d4dcbecb47c8ea93f134c0628eef9 (patch)
tree4cb5d945b8b75c7a8e639ade0fe6b3ae4bba1ff7 /docs/cli_development.md
parent47356b220101b4f5b8ca71b2e1aa4f04256dd60f (diff)
parentb39285807e1d21300e8a5dbbf6f2c43a8aab3494 (diff)
downloadqmk_firmware-6ca94ae1587d4dcbecb47c8ea93f134c0628eef9.tar.gz
qmk_firmware-6ca94ae1587d4dcbecb47c8ea93f134c0628eef9.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/cli_development.md')
-rw-r--r--docs/cli_development.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/cli_development.md b/docs/cli_development.md
index e94884de2e..159bca4faa 100644
--- a/docs/cli_development.md
+++ b/docs/cli_development.md
@@ -192,11 +192,15 @@ We use nose2, flake8, and yapf to test, lint, and format code. You can use the `
### Testing and Linting
- qmk pytest
+```
+qmk pytest
+```
### Formatting
- qmk format-python
+```
+qmk format-python
+```
## Formatting Details
@@ -212,7 +216,9 @@ Our tests can be found in `lib/python/qmk/tests/`. You will find both unit and i
If your PR does not include a comprehensive set of tests please add comments like this to your code so that other people know where they can help:
+```python
# TODO(unassigned/<your_github_username>): Write <unit|integration> tests
+```
We use [nose2](https://nose2.readthedocs.io/en/latest/getting_started.html) to run our tests. You can refer to the nose2 documentation for more details on what you can do in your test functions.