aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cli.md
diff options
context:
space:
mode:
authorErovia <erovia@users.noreply.github.com>2019-10-13 20:23:11 +0200
committerskullydazed <skullydazed@users.noreply.github.com>2019-10-23 22:46:30 -0700
commita5a31a5fc0f14f4f66cf362ee85747be159e364d (patch)
tree6e9788f22fa7c8207bd217bae7a2b6e50450b7a5 /docs/cli.md
parent4da9d2ef6f3f3a91738a209f8e692d7294ef70d5 (diff)
downloadfirmware-a5a31a5fc0f14f4f66cf362ee85747be159e364d.tar.gz
firmware-a5a31a5fc0f14f4f66cf362ee85747be159e364d.tar.bz2
firmware-a5a31a5fc0f14f4f66cf362ee85747be159e364d.zip
MILC: Use dashes instead of underscores for subcommands
The subcommand functions' name follows the Python convention of using snake case, but looks odd on the command line. Fix it by converting underscores to dashes, eg.: list_keyboards -> list-keyboards.
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cli.md b/docs/cli.md
index d150ee917..0d3703c8c 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -125,14 +125,14 @@ This command examines your environment and alerts you to potential build or flas
qmk doctor
```
-## `qmk list_keyboards`
+## `qmk list-keyboards`
This command lists all the keyboards currently defined in `qmk_firmware`
**Usage**:
```
-qmk list_keyboards
+qmk list-keyboards
```
## `qmk new-keymap`