Cylc pause help fix (#5685)

cylc · Aug 14, 2023 · c452aff · c452aff
1 parent 0fa96d0
commit c452aff
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/changes.d/5685.fix.md b/changes.d/5685.fix.md
@@ -0,0 +1,2 @@
+Fix "cylc pause" command help (it targets workflows, not tasks, but was
+printing task-matching documentation as well).
diff --git a/cylc/flow/scripts/pause.py b/cylc/flow/scripts/pause.py
@@ -20,7 +20,7 @@
 
 Pause a workflow.
 
-This suspends submission of tasks.
+This suspends submission of all tasks in a workflow.
 
 Examples:
   # pause my_flow
@@ -29,7 +29,8 @@
   # resume my_flow
   $ cylc play my_flow
 
-Not to be confused with `cylc hold`.
+(Not to be confused with `cylc hold` which suspends submission of individual
+tasks within a workflow).
 """
 
 from functools import partial
@@ -64,7 +65,7 @@ def get_option_parser() -> COP:
     parser = COP(
         __doc__,
         comms=True,
-        multitask=True,
+        multitask=False,
         multiworkflow=True,
         argdoc=[WORKFLOW_ID_MULTI_ARG_DOC],
     )