Skip to content

Commit f6199a2

Browse files
committed
Fixed a doc build warning
1 parent 18ca538 commit f6199a2

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

docs/plugins/external_test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def example_app():
4646

4747
## Writing Tests
4848

49-
Now write your tests that validate your application using the [cmd2_ext_test.ExternalTestMixin.app_cmd][] function to access the cmd2 application's commands. This allows invocation of the application's commands in the same format as a user would type. The results from calling a command matches what is returned from running an python script with cmd2's [run_pyscript](../features/builtin_commands.md#run_pyscript) command, which provides `stdout`, `stderr`, and the command's result data.
49+
Now write your tests that validate your application using the `cmd2_ext_test.ExternalTestMixin.app_cmd` function to access the cmd2 application's commands. This allows invocation of the application's commands in the same format as a user would type. The results from calling a command matches what is returned from running an python script with cmd2's [run_pyscript](../features/builtin_commands.md#run_pyscript) command, which provides `stdout`, `stderr`, and the command's result data.
5050

5151
```py
5252
from cmd2 import CommandResult

docs/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This covers special considerations when writing unit tests for a cmd2 applicatio
66

77
## Testing Commands
88

9-
The [External Test Plugin](plugins/external_test.md) provides a mixin class with an function that allows external calls to application commands. The `cmd2_ext_test.ExternalTestMixin.app_cmd()` function captures and returns stdout, stderr, and the command-specific result data.
9+
The [External Test Plugin](plugins/external_test.md) provides a mixin class with an function that allows external calls to application commands. The `cmd2_ext_test.ExternalTestMixin.app_cmd` function captures and returns stdout, stderr, and the command-specific result data.
1010

1111
## Mocking
1212

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ dependencies = [
3737
[project.optional-dependencies]
3838
build = ["build", "setuptools", "setuptools-scm"]
3939
dev = [
40+
"black",
4041
"codecov",
4142
"griffe-typingdoc",
4243
"invoke",
@@ -52,6 +53,7 @@ dev = [
5253
"twine",
5354
]
5455
docs = [
56+
"black",
5557
"griffe-typingdoc",
5658
"mkdocs-include-markdown-plugin",
5759
"mkdocs-macros-plugin",
@@ -275,6 +277,7 @@ packages = ["cmd2"]
275277

276278
[tool.uv]
277279
dev-dependencies = [
280+
"black",
278281
"build",
279282
"cmd2-ext-test",
280283
"codecov",

0 commit comments

Comments
 (0)