From c452aff6275247d7db4946dd64b9b3022810db27 Mon Sep 17 00:00:00 2001
From: Hilary James Oliver <hilary.j.oliver@gmail.com>
Date: Mon, 14 Aug 2023 21:25:54 +1200
Subject: [PATCH] Cylc pause help fix (#5685)

---
 changes.d/5685.fix.md      | 2 ++
 cylc/flow/scripts/pause.py | 7 ++++---
 2 files changed, 6 insertions(+), 3 deletions(-)
 create mode 100644 changes.d/5685.fix.md

diff --git a/changes.d/5685.fix.md b/changes.d/5685.fix.md
new file mode 100644
index 00000000000..65a14c314c0
--- /dev/null
+++ 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
index a597a3fe941..4b47fdc6858 100644
--- 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],
     )