Skip to content

Commit a27cc98

Browse files
committed
Address review comments.
1 parent b8d8951 commit a27cc98

File tree

7 files changed

+31
-37
lines changed

7 files changed

+31
-37
lines changed

src/7-to-8/major-changes/compatibility-mode.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The ``suite.rc`` filename triggers a backward compatibility mode in which:
3333
- (Cylc 8 spawns tasks on demand, and suicide triggers are not needed for
3434
branching)
3535

36-
- ``succeeded`` task outputs are :ref:`*required* <User Guide Required Outputs>`,
36+
- ``succeeded`` task outputs are :ref:`required <User Guide Required Outputs>`,
3737
so in the absence of suicide triggers the scheduler will retain other
3838
:term:`final status` tasks in the :term:`n=0 window <n-window>` to stall the
3939
workflow.

src/glossary.rst

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,11 @@ Glossary
106106
window
107107
n-window
108108
active window
109-
The UI provides a :term:`graph`-based window or view of the workflow at
109+
The GUI provides a :term:`graph`-based window or view of the workflow at
110110
runtime, including tasks out to ``n`` graph edges from current
111111
:term:`active tasks <active task>`.
112112

113-
Active tasks form the ``n=0`` core of the :term:`n-window`.
113+
Active tasks form the ``n=0``` window.
114114

115115
.. seealso::
116116

@@ -1383,17 +1383,6 @@ Glossary
13831383
- ``:succeeded``, or ``:failed``
13841384

13851385

1386-
prerequisite
1387-
task prerequisite
1388-
A task's prerequisites are the :term:`outputs <task output>` of
1389-
parent tasks upstream in the graph that must be completed before
1390-
it can run. Tasks are said to "depend on" their prerequisites, hence
1391-
the term :term:`dependency graph <graph>`.
1392-
1393-
Tasks can depend on :term:`external triggers <xtrigger>` as well as
1394-
the outputs of other, upstream, tasks.
1395-
1396-
13971386
output
13981387
task output
13991388
Task outputs mark the progression of a :term:`task` from waiting (for
@@ -1426,8 +1415,9 @@ Glossary
14261415
A task's outputs are *complete* if its *output completion condition*
14271416
is satisfied.
14281417

1429-
The completion condition can be defined by the user, or otherwise
1430-
it is automatically generated according to the rules:
1418+
The completion condition can be defined by the user in
1419+
:cylc:conf:`flow.cylc[runtime][<namespace>]completion`,
1420+
otherwise it is automatically generated according to the rules:
14311421

14321422
- All :term:`required outputs <required output>` (referenced in the graph)
14331423
must be completed.
@@ -1444,10 +1434,13 @@ Glossary
14441434
the workflow.
14451435

14461436

1437+
prerequisite
14471438
dependence
14481439
dependency
14491440
Dependencies in the :term:`graph` show how :term:`tasks <task>` depend on
14501441
some combination of the :term:`outputs <task output>` of other tasks.
1442+
These dependencies are also called the prerequisites of the downstream.
1443+
task.
14511444

14521445
For example, in the following dependency the task ``baz`` depends on both
14531446
``foo`` and ``bar`` succeeding:
@@ -1462,6 +1455,8 @@ Glossary
14621455
* :term:`conditional dependence`
14631456
* :term:`intercycle dependence`
14641457

1458+
Tasks can also depend on :term:`external triggers <xtrigger>`.
1459+
14651460

14661461
conditional dependence
14671462
conditional dependency

src/user-guide/running-workflows/workflow-completion.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
Workflow Completion
44
===================
55

6-
A workflow is complete, and the scheduler will automatically
7-
:term:`shut down <shutdown>`, if no tasks remain in the
8-
:term:`n=0 <n-window>`.
9-
10-
That is, all active tasks have finished, and no tasks remain waiting on
11-
:term:`prerequisites <prerequisite>` or "external" constraints (such as
12-
:term:`xtriggers <xtrigger>` or task :term:`hold`).
13-
14-
If no active tasks remain and all external constraints are satisfied,
15-
but the n=0 window contains tasks waiting with partially satisfied
16-
:term:`prerequisites <prerequisite>`, or tasks with :term:`final status` and
17-
:term:`incomplete outputs <output completion>`, then the workflow is
18-
not complete and the scheduler will :term:`stall` pending manual intervention.
6+
A workflow is complete, and the scheduler will automatically
7+
:term:`shut down <shutdown>`, if no tasks remain in the
8+
:term:`n=0 <n-window>`.
9+
10+
That is, all active tasks have finished, and no tasks remain waiting on
11+
:term:`prerequisites <prerequisite>` or "external" constraints (such as
12+
:term:`xtriggers <xtrigger>` or task :term:`hold`).
13+
14+
If no active tasks remain and all external constraints are satisfied,
15+
but the n=0 window contains tasks waiting with partially satisfied
16+
:term:`prerequisites <prerequisite>`, or tasks with :term:`final status` and
17+
:term:`incomplete outputs <output completion>`, then the workflow is
18+
not complete and the scheduler will :term:`stall` pending manual intervention.
1919

2020

2121
.. _scheduler stall:

src/user-guide/writing-workflows/external-triggers.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ this:
170170
'task': task_name,
171171
'point': cycle_point,
172172
'status': task_status, # or
173-
'trigger': task_output_trigger, # or
174-
'message': task_output_message,
173+
'trigger': task_output_trigger, # or
174+
'message': task_output_message,
175175
'flow_num': flow_num # if given
176176
}
177177
return (satisfied, results)
@@ -193,8 +193,8 @@ To see this, take a look at the job script for one of the downstream tasks:
193193
export upstream_workflow upstream_cylc_run_dir upstream_offset \
194194
upstream_message upstream_status upstream_point upstream_task
195195
upstream_workflow="up"
196-
upstream_task="foo"
197-
upstream_point="2011"
196+
upstream_task="foo"
197+
upstream_point="2011"
198198
upstream_status="succeeded"
199199
}
200200
...
@@ -398,7 +398,6 @@ success. The function signature is:
398398
.. automodule:: cylc.flow.xtriggers.xrandom
399399
:members: xrandom, validate
400400
:member-order: bysource
401-
:noindex:
402401

403402
An example xrandom trigger workflow:
404403

src/user-guide/writing-workflows/scheduling.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1560,7 +1560,7 @@ intervention, e.g. to be retriggered after a bug fix.
15601560
Tasks that achieve a final status without completing their outputs will
15611561
raise a warning and stall the workflow when there is nothing else for
15621562
the scheduler to run (see :ref:`workflow completion`). They also count
1563-
toward the :term:`runahead limit`, because they may run again once dealt with.
1563+
toward the :term:`runahead limit`.
15641564

15651565
This graph says task ``bar`` should trigger if ``foo`` succeeds:
15661566

src/workflows/xtrigger/sequential/flow.cylc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
initial cycle point = 2010
55
sequential xtriggers = True
66
[[xtriggers]]
7-
upstream = workflow_state(up//%(point)s/foo:x):PT10S
7+
upstream = workflow_state("up//%(point)s/foo:x"):PT10S
88
clock_0 = wall_clock(offset=PT0H, sequential=False)
99
[[graph]]
1010
P1Y = """

src/workflows/xtrigger/workflow_state/downstream/flow.cylc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[scheduling]
44
initial cycle point = 2010
55
[[xtriggers]]
6-
upstream = workflow_state(up//%(point)s/foo:x):PT10S
6+
upstream = workflow_state("up//%(point)s/foo:x"):PT10S
77
clock_0 = wall_clock(offset=PT0H)
88
[[graph]]
99
P1Y = """

0 commit comments

Comments
 (0)