Skip to content

💫 Toolkit to help you get started with SDD or any other process!

docs(workflows): init step docstring lists the 'py' script type (#3655)

Ali jawwad3356161d88c4
diff --git a/src/specify_cli/workflows/steps/init/__init__.py b/src/specify_cli/workflows/steps/init/__init__.py
index 550e0624f..5dc1ee9c0 100644
--- a/src/specify_cli/workflows/steps/init/__init__.py
+++ b/src/specify_cli/workflows/steps/init/__init__.py
@@ -59,7 +59,7 @@ class InitStep(StepBase):
Extra options for the integration (e.g. ``"--skills"`` or
``"--commands-dir .myagent/cmds"``).
``script``
- Script type, ``sh`` or ``ps``.
+ Script type, ``sh``, ``ps``, or ``py``.
``force``
Merge/overwrite without confirmation when the directory is not
empty.
diff --git a/tests/test_workflows.py b/tests/test_workflows.py
index 00cf1f2be..b83514ef9 100644
--- a/tests/test_workflows.py
+++ b/tests/test_workflows.py
@@ -1935,6 +1935,14 @@ def _force_gate_stdin(monkeypatch, *, tty: bool):
class TestInitStep:
"""Test the init step type."""
+ def test_docstring_lists_every_valid_script_type(self):
+ # The `script` field docstring must not contradict the step's own
+ # VALID_SCRIPT_TYPES (which includes 'py'); validate() accepts all three.
+ from specify_cli.workflows.steps.init import InitStep, VALID_SCRIPT_TYPES
+
+ for script_type in VALID_SCRIPT_TYPES:
+ assert f"``{script_type}``" in InitStep.__doc__
+
def test_builds_here_argv_and_bootstraps(self, tmp_path):
from specify_cli.workflows.steps.init import InitStep
from specify_cli.workflows.base import StepContext, StepStatus