diff --git a/cylc/flow/option_parsers.py b/cylc/flow/option_parsers.py index 5f6828134ee..26b7620566c 100644 --- a/cylc/flow/option_parsers.py +++ b/cylc/flow/option_parsers.py @@ -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: # Operate on two tasks workflow //cycle-1/task-1 //cycle-2/task-2 Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles + # Match any active task "foo" in all cycles '//*/foo' # Match the tasks "foo-1" and "foo-2" @@ -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: # Operate on two workflows workflow-1 workflow-2 diff --git a/cylc/flow/scripts/hold.py b/cylc/flow/scripts/hold.py index 7f6992a6536..8a7ade3c2e5 100755 --- a/cylc/flow/scripts/hold.py +++ b/cylc/flow/scripts/hold.py @@ -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".