Skip to content

Commit 71b18fe

Browse files
cidrblockshatakshiiii
authored andcommitted
Add additional docstring entries
1 parent b5d2574 commit 71b18fe

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
A CLI tool for scaffolding all your Ansible Content.
1212

13-
## Installation DNM
13+
## Installation
1414

1515
```shell
1616
pip install ansible-creator

tests/units/test_add.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,7 @@ def test_devcontainer_usability(
403403
cli_args: Dictionary, partial Add class object.
404404
405405
Raises:
406+
AssertionError: If the assertion fails.
406407
FileNotFoundError: If the 'npm' or 'docker' executable is not found in the PATH.
407408
"""
408409
# Set the resource_type to devcontainer
@@ -520,6 +521,9 @@ def test_run_success_add_plugin( # noqa: PLR0913, # pylint: disable=too-many-po
520521
plugin_name: Name of the plugin to add.
521522
expected_message: Expected success message.
522523
expected_file_path: Expected file path for the plugin.
524+
525+
Raises:
526+
AssertionError: If the assertion fails.
523527
"""
524528
cli_args["plugin_type"] = plugin_type
525529
cli_args["plugin_name"] = plugin_name
@@ -765,6 +769,9 @@ def test_run_success_add_play_argspec(
765769
tmp_path: Temporary directory path.
766770
cli_args: Dictionary, partial Add class object.
767771
monkeypatch: Pytest monkeypatch fixture.
772+
773+
Raises:
774+
AssertionError: If the assertion fails.
768775
"""
769776
# Set the resource_type to play-argspec
770777
cli_args["resource_type"] = "play-argspec"
@@ -827,6 +834,7 @@ def test_run_success_add_role(
827834
monkeypatch: Pytest monkeypatch fixture.
828835
829836
Raises:
837+
AssertionError: If the assertion fails.
830838
ValueError: If the file is not found.
831839
"""
832840
# Set the resource_type to role
@@ -972,6 +980,7 @@ def test_role_galaxy(tmp_path: Path, cli_args: ConfigDict) -> None:
972980
973981
Raises:
974982
AssertionError: If the assertion fails.
983+
AssertionError: If the namespace or collection name mismatch.
975984
"""
976985
galaxy_file = tmp_path / "galaxy.yml"
977986
initial_data: dict[str, Any]
@@ -1015,6 +1024,9 @@ def test_run_success_add_pattern(
10151024
capsys: Pytest fixture to capture stdout and stderr.
10161025
cli_args: Dictionary, partial Add class object.
10171026
monkeypatch: Pytest monkeypatch fixture.
1027+
1028+
Raises:
1029+
AssertionError: If the assertion fails.
10181030
"""
10191031
# Set the resource_type to pattern
10201032
cli_args["resource_type"] = "pattern"

0 commit comments

Comments
 (0)