summaryrefslogtreecommitdiff
path: root/lib/python
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2021-07-23 21:41:33 +0100
committerGitHub <noreply@github.com>2021-07-23 21:41:33 +0100
commitfdcea0633657fba4cebcef45eee2f103d162e28c (patch)
tree6d547e2154fa55aea125bc6fc08420c18c8f232a /lib/python
parent164a74a078722cc488526c0c8fcbc4e1b54a5780 (diff)
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 'lib/python')
-rw-r--r--lib/python/qmk/cli/format/c.py2
-rw-r--r--lib/python/qmk/tests/test_cli_commands.py12
2 files changed, 7 insertions, 7 deletions
diff --git a/lib/python/qmk/cli/format/c.py b/lib/python/qmk/cli/format/c.py
index 699de8d49c..b7263e19f3 100644
--- a/lib/python/qmk/cli/format/c.py
+++ b/lib/python/qmk/cli/format/c.py
@@ -127,7 +127,7 @@ def format_c(cli):
# Sanity check
if not files:
- cli.log.error('No changed files detected. Use "qmk cformat -a" to format all core files')
+ cli.log.error('No changed files detected. Use "qmk format-c -a" to format all core files')
return False
# Run clang-format on the files we've found
diff --git a/lib/python/qmk/tests/test_cli_commands.py b/lib/python/qmk/tests/test_cli_commands.py
index b341e1c912..022b242034 100644
--- a/lib/python/qmk/tests/test_cli_commands.py
+++ b/lib/python/qmk/tests/test_cli_commands.py
@@ -31,13 +31,13 @@ def check_returncode(result, expected=[0]):
assert result.returncode in expected
-def test_cformat():
- result = check_subcommand('cformat', '-n', 'quantum/matrix.c')
+def test_format_c():
+ result = check_subcommand('format-c', '-n', 'quantum/matrix.c')
check_returncode(result)
-def test_cformat_all():
- result = check_subcommand('cformat', '-n', '-a')
+def test_format_c_all():
+ result = check_subcommand('format-c', '-n', '-a')
check_returncode(result, [0, 1])
@@ -80,8 +80,8 @@ def test_hello():
assert 'Hello,' in result.stdout
-def test_pyformat():
- result = check_subcommand('pyformat', '--dry-run')
+def test_format_python():
+ result = check_subcommand('format-python', '--dry-run')
check_returncode(result)
assert 'Python code in `bin/qmk` and `lib/python` is correctly formatted.' in result.stdout