Skip to content

Commit

Permalink
Merge pull request #5986 from hjoliver/cli-typo-fix
Browse files Browse the repository at this point in the history
CLI: glob and hold help tweaks
  • Loading branch information
hjoliver authored Feb 22, 2024
2 parents 1856578 + 73befca commit 9936262
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
8 changes: 4 additions & 4 deletions cylc/flow/option_parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -328,14 +328,14 @@ class CylcOptionParser(OptionParser):
"""Common options for all cylc CLI commands."""

MULTITASK_USAGE = cparse(dedent('''
This command can operate on multiple tasks, globs and selectors may
be used:
This command can operate on multiple tasks. Globs and selectors may
be used to match active tasks:
Multiple Tasks:
<dim># Operate on two tasks</dim>
workflow //cycle-1/task-1 //cycle-2/task-2
Globs (note: globs should be quoted and only match active tasks):
<dim># Match any the active task "foo" in all cycles</dim>
<dim># Match any active task "foo" in all cycles</dim>
'//*/foo'
<dim># Match the tasks "foo-1" and "foo-2"</dim>
Expand All @@ -348,7 +348,7 @@ class CylcOptionParser(OptionParser):
See `cylc help id` for more details.
'''))
MULTIWORKFLOW_USAGE = cparse(dedent('''
This command can operate on multiple workflows, globs may also be used:
This command can operate on multiple workflows. Globs may be used:
Multiple Workflows:
<dim># Operate on two workflows</dim>
workflow-1 workflow-2
Expand Down
8 changes: 7 additions & 1 deletion cylc/flow/scripts/hold.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@
Hold task(s) in a workflow.
Held tasks do not submit their jobs even if ready to run.
Held tasks do not submit jobs even if ready.
Any task can be held.
Note: a held running task will not submit more jobs itself (e.g. by retries)
until released, but the running job may still complete outputs that cause
non-held downstream tasks to trigger.
To pause an entire workflow use "cylc pause".
Expand Down

0 comments on commit 9936262

Please sign in to comment.