Merge pull request #5699 from hjoliver/fix-cli-help-my_flow

Change my_flow to my_workflow in CLI help.

Author: oliver-sanders

cylc/flow/scripts/hold.py

@@ -25,29 +25,29 @@
 To pause an entire workflow use "cylc pause".
 
 Examples:
-  # Hold mytask at cycle point 1234 in my_flow (if it has not yet spawned, it
-  # will hold as soon as it spawns):
-  $ cylc hold my_flow//1234/mytask
+  # Hold mytask at cycle point 1234 in my_workflow (if it has not yet spawned,
+  # it will hold as soon as it spawns):
+  $ cylc hold my_workflow//1234/mytask
 
-  # Hold all active tasks at cycle 1234 in my_flow (note: tasks before/after
-  # this cycle point will not be held):
-  $ cylc hold 'my_flow//1234/*'
+  # Hold all active tasks at cycle 1234 in my_workflow (note: tasks
+  # before/after this cycle point will not be held):
+  $ cylc hold 'my_workflow//1234/*'
 
-  # Hold all active instances of mytask in my_flow (note: this will not hold
-  # any unspawned tasks that might spawn in the future):
-  $ cylc hold 'my_flow//*/mytask'
+  # Hold all active instances of mytask in my_workflow (note: this will not
+  # hold any unspawned tasks that might spawn in the future):
+  $ cylc hold 'my_workflow//*/mytask'
 
   # Hold all active failed tasks:
-  $ cylc hold 'my_flow//*:failed'
+  $ cylc hold 'my_workflow//*:failed'
 
-  # Hold all tasks after cycle point 1234 in my_flow:
-  $ cylc hold my_flow// --after=1234
+  # Hold all tasks after cycle point 1234 in my_workflow:
+  $ cylc hold my_workflow// --after=1234
 
-  # Hold cycles 1, 2 & 3 in my_flow:
-  $ cylc hold my_flow// //1 //2 //3
+  # Hold cycles 1, 2 & 3 in my_workflow:
+  $ cylc hold my_workflow// //1 //2 //3
 
-  # Hold cycle "1" in "my_flow_1" and "my_flow_2":
-  $ cylc hold my_flow_1//1 my_flow_2//1
+  # Hold cycle "1" in "my_workflow_1" and "my_workflow_2":
+  $ cylc hold my_workflow_1//1 my_workflow_2//1
 
 Note: To pause a workflow (immediately preventing all job submission), use
 'cylc pause' instead.

cylc/flow/scripts/kill.py

@@ -21,14 +21,14 @@
 Kill running or submitted jobs.
 
 Examples:
-  # kill a specific task in my_flow
-  $ cylc kill my_flow//1/a
+  # kill a specific task in my_workflow
+  $ cylc kill my_workflow//1/a
 
-  # kill multiple tasks in my_flow
+  # kill multiple tasks in my_workflow
   $ cylc kill myflow// //1/a //1/b //1/c
 
-  # kill all active tasks in the my_flow
-  $ cylc kill 'my_flow//*'
+  # kill all active tasks in the my_workflow
+  $ cylc kill 'my_workflow//*'
 """
 
 from functools import partial

cylc/flow/scripts/pause.py

@@ -23,11 +23,11 @@
 This suspends submission of all tasks in a workflow.
 
 Examples:
-  # pause my_flow
-  $ cylc pause my_flow
+  # pause my_workflow
+  $ cylc pause my_workflow
 
-  # resume my_flow
-  $ cylc play my_flow
+  # resume my_workflow
+  $ cylc play my_workflow
 
 (Not to be confused with `cylc hold` which suspends submission of individual
 tasks within a workflow).

cylc/flow/scripts/poll.py

@@ -26,11 +26,11 @@
 including incomplete finished tasks.
 
 Examples:
-  # poll all pollable tasks in my_flow
-  $ cylc poll 'my_flow//*'
+  # poll all pollable tasks in my_workflow
+  $ cylc poll 'my_workflow//*'
 
-  # poll specific tasks in my_flow
-  $ cylc poll my_flow// //1/a //1/b
+  # poll specific tasks in my_workflow
+  $ cylc poll my_workflow// //1/a //1/b
 """
 
 from functools import partial

cylc/flow/scripts/release.py

@@ -21,17 +21,17 @@
 Release held tasks in a workflow.
 
 Examples:
-  # Release mytask at cycle 1234 in my_flow
-  $ cylc release my_flow//1234/mytask
+  # Release mytask at cycle 1234 in my_workflow
+  $ cylc release my_workflow//1234/mytask
 
-  # Release all active tasks at cycle 1234 in my_flow
-  $ cylc release 'my_flow//1234/*'
+  # Release all active tasks at cycle 1234 in my_workflow
+  $ cylc release 'my_workflow//1234/*'
 
-  # Release all active instances of mytask in my_flow
-  $ cylc release 'my_flow//*/mytask'
+  # Release all active instances of mytask in my_workflow
+  $ cylc release 'my_workflow//*/mytask'
 
   # Release all held tasks and remove the hold point
-  $ cylc release my_flow --all
+  $ cylc release my_workflow --all
 
 Held tasks do not submit their jobs even if ready to run.
 

cylc/flow/scripts/reload.py

@@ -23,15 +23,15 @@
 Example:
   # install and run the workflow
   $ cylc install
-  $ cylc play my_flow
+  $ cylc play my_workflow
 
   # make changes to the workflow source directory
 
   # reinstall the workflow
-  $ cylc reinstall my_flow
+  $ cylc reinstall my_workflow
 
   # reload the workflow to pick up changes
-  $ cylc reload my_flow
+  $ cylc reload my_workflow
   # the workflow is now running with the new config
 
 All settings including task definitions, with the exception of workflow log

cylc/flow/scripts/set_outputs.py

@@ -36,13 +36,13 @@
   '''
 
   # spawn 1/b and 1/c, but 1/d will not subsequently run
-  $ cylc set-outputs my_flow//1/a
+  $ cylc set-outputs my_workflow//1/a
 
   # spawn 1/b and 1/c as flow 2, followed by 1/d
-  $ cylc set-outputs --flow=2 my_flow//1/a
+  $ cylc set-outputs --flow=2 my_workflow//1/a
 
   # spawn 1/bar as flow 3, followed by 1/baz
-  $ cylc set-outputs --flow=3 --output=x my_flow//1/foo
+  $ cylc set-outputs --flow=3 --output=x my_workflow//1/foo
 
 Use --output multiple times to spawn off of several outputs at once.
 """

cylc/flow/scripts/stop.py

@@ -22,22 +22,22 @@
 
 Examples:
   # wait for active tasks to finish, then shut down
-  $ cylc stop my_flow
+  $ cylc stop my_workflow
 
   # kill active tasks, then shut down
-  $ cylc stop my_flow --kill
+  $ cylc stop my_workflow --kill
 
   # shut down immediately, leave active tasks alone
-  $ cylc stop my_flow --now
+  $ cylc stop my_workflow --now
 
   # shut down all workflows
   $ cylc stop '*'
 
   # shut down after the cycle 1234 has been passed
-  $ cylc stop my_flow//1234
+  $ cylc stop my_workflow//1234
 
   # shut down after the task foo in cycle 1234 has succeeded
-  $ cylc stop my_flow//1234/foo
+  $ cylc stop my_workflow//1234/foo
 
 By default stopping workflows wait for submitted and running tasks to complete
 before shutting down. You can change this behaviour with the --mode option.