drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Docs theme updates (#23832)

Browse source
This commit is contained in:
Joel Challis 2024-05-31 01:34:30 +01:00 • committed by GitHub
parent 32af90ae84
commit 119e54e9e3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 22 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/cli_development.md
View file

@ -207,7 +207,7 @@ qmk format-python
We use [yapf](https://github.com/google/yapf) to automatically format code. Our configuration is in the `[yapf]` section of `setup.cfg`.
::: tip
Tip- Many editors can use yapf as a plugin to automatically format code as you type.
Many editors can use yapf as a plugin to automatically format code as you type.
:::
## Testing Details
@ -217,7 +217,7 @@ 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
# 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.