docs: clarify exec shell override guidance

Maintainer edit: make the shell parameter description explain defaults and when to override instead of only listing shell names.
2026-07-06 12:11:25 +08:00
parent 8222f3c85f
commit 4ec111c1a9
2 changed files with 10 additions and 2 deletions
@@ -63,10 +63,14 @@ def test_exec_tool_shell_guidance_matches_platform() -> None:

    shell_parameter = ExecTool().parameters["properties"]["shell"]["description"].lower()
    if sys.platform == "win32":
+        assert "override the windows shell only when needed" in shell_parameter
+        assert "omit to use powershell by default" in shell_parameter
        assert "powershell" in shell_parameter
        assert "cmd" in shell_parameter
        assert "unix" not in shell_parameter
    else:
+        assert "override the unix shell only when needed" in shell_parameter
+        assert "omit to use bash by default" in shell_parameter
        assert "unix" in shell_parameter
        assert "powershell" not in shell_parameter
        assert "cmd" not in shell_parameter