Skip to content

Commit 9936262

Browse files
authored
Merge pull request #5986 from hjoliver/cli-typo-fix
CLI: glob and hold help tweaks
2 parents 1856578 + 73befca commit 9936262

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

cylc/flow/option_parsers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,14 @@ class CylcOptionParser(OptionParser):
328328
"""Common options for all cylc CLI commands."""
329329

330330
MULTITASK_USAGE = cparse(dedent('''
331-
This command can operate on multiple tasks, globs and selectors may
332-
be used:
331+
This command can operate on multiple tasks. Globs and selectors may
332+
be used to match active tasks:
333333
Multiple Tasks:
334334
<dim># Operate on two tasks</dim>
335335
workflow //cycle-1/task-1 //cycle-2/task-2
336336
337337
Globs (note: globs should be quoted and only match active tasks):
338-
<dim># Match any the active task "foo" in all cycles</dim>
338+
<dim># Match any active task "foo" in all cycles</dim>
339339
'//*/foo'
340340
341341
<dim># Match the tasks "foo-1" and "foo-2"</dim>
@@ -348,7 +348,7 @@ class CylcOptionParser(OptionParser):
348348
See `cylc help id` for more details.
349349
'''))
350350
MULTIWORKFLOW_USAGE = cparse(dedent('''
351-
This command can operate on multiple workflows, globs may also be used:
351+
This command can operate on multiple workflows. Globs may be used:
352352
Multiple Workflows:
353353
<dim># Operate on two workflows</dim>
354354
workflow-1 workflow-2

cylc/flow/scripts/hold.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
2121
Hold task(s) in a workflow.
2222
23-
Held tasks do not submit their jobs even if ready to run.
23+
Held tasks do not submit jobs even if ready.
24+
25+
Any task can be held.
26+
27+
Note: a held running task will not submit more jobs itself (e.g. by retries)
28+
until released, but the running job may still complete outputs that cause
29+
non-held downstream tasks to trigger.
2430
2531
To pause an entire workflow use "cylc pause".
2632

0 commit comments

Comments
 (0)