Skip to content

Commit 4b80443

Browse files
committed
Tweak terminology.
1 parent d8d5d29 commit 4b80443

File tree

7 files changed

+42
-41
lines changed

7 files changed

+42
-41
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ 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-
- only ``succeeded`` task outputs are :ref:`*required* <User Guide Required Outputs>`,
37-
so the scheduler will retain all non-succeeded :term:`finished tasks <finished task>`
36+
- ``succeeded`` task outputs are :ref:`*required* <User Guide Required Outputs>`,
37+
so the scheduler will retain all other tasks with :term:`final status`
3838
in the :term:`n=0 window <n-window>`.
3939

4040
- (in Cylc 8, **all** outputs are *required* unless marked as

src/7-to-8/summary.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,9 @@ Optional and Required Task Outputs
121121
* User Guide::ref:`User Guide Optional Outputs`
122122

123123
By default, all Cylc 8 tasks are required to succeed - i.e., success is
124-
a :term:`required output`. Tasks that :term:`finish <finished task>`
125-
without completing their required outputs get retained in the
126-
:term:`n=0 window <n-window>` pending user intervention, which
127-
will :term:`stall` the workflow.
124+
a :term:`required output`. Tasks with :term:`final status` and incomplete
125+
outputs get retained in the :term:`n=0 window <n-window>` pending user
126+
intervention, which will :term:`stall` the workflow.
128127

129128
Alternatively, outputs can be marked as :term:`optional <optional output>`,
130129
which allows :term:`optional graph branching <graph branching>`.

src/glossary.rst

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Glossary
8686

8787
- ``preparing`` tasks - i.e. tasks in the process of submitting jobs
8888
- ``submitted`` and ``running`` tasks - i.e. those with active jobs
89-
- tasks that finished without completing their
89+
- tasks that reached a :term:`final status` without completing their
9090
:term:`required outputs <required output>`
9191
(e.g. a task failed where success was required).
9292

@@ -570,7 +570,7 @@ Glossary
570570
Tasks in :term:`datetime cycling` workflows can be configured to *expire*
571571
if the :term:`wallclock time` exceeds some offset from the cycle point.
572572

573-
Expired is a :term:`final task status` - an expired task will not run
573+
Expired is a :term:`final status` - an expired task will not run
574574
even if its prerequisites get satisfied.
575575

576576
The associated ``:expire`` :term:`output <task output>` can be used to
@@ -862,9 +862,8 @@ Glossary
862862

863863

864864
job
865-
Jobs are the real processes that run on a computer to realise
866-
:term:`tasks <task>` in a :term:`workflow`. In Cylc, they are
867-
implemented by :term:`job scripts
865+
Jobs are the real processes that :term:`tasks <task>` represent in
866+
a :term:`workflow`. In Cylc, they are implemented by :term:`job scripts
868867
<job script>` prepared by the :term:`scheduler`.
869868

870869

@@ -1371,11 +1370,10 @@ Glossary
13711370
* :ref:`Cylc User Guide <FamilyTriggers>`
13721371

13731372

1374-
final task status
1375-
finished task
1376-
A finished task has achieved a final task status, i.e., expired,
1377-
submit-failed, succeeded, or failed. Finished tasks cannot change
1378-
state again except by manual intervention (e.g. by retriggering).
1373+
final status
1374+
A task that has achieved a final status (expired, submit-failed,
1375+
succeeded, or failed) will not change state in the workflow, except by
1376+
manual intervention.
13791377

13801378

13811379
standard output
@@ -1413,6 +1411,8 @@ Glossary
14131411
foo => bar # means foo:succeeded => bar
14141412
14151413
1414+
complete
1415+
incomplete
14161416
output completion
14171417
output completion condition
14181418
A task's outputs are *complete* if its *output completion condition*
@@ -1428,11 +1428,12 @@ Glossary
14281428
submit-fails.
14291429
- Or, if expiry is optional, then the outputs are complete if it expires.
14301430

1431-
Tasks that :term:`finish <finished task>` with
1432-
:term:`complete outputs <output completion>`
1433-
have done their job, allowing the workflow to move on.
1431+
Tasks that achieve a :term:`final status` with
1432+
:term:`complete outputs <output completion>` have done their job in the
1433+
workflow, allowing the workflow to move on.
14341434

1435-
Tasks that finish with :term:`incomplete outputs <output completion>`
1435+
Tasks that achieve a final status with
1436+
:term:`incomplete outputs <output completion>`
14361437
are retained in :term:`n=0 <n-window>` pending user
14371438
intervention, and will :term:`stall` the workflow.
14381439

@@ -1567,7 +1568,7 @@ Glossary
15671568
expected output
15681569
Task outputs that are not marked as :term:`optional <optional output>`
15691570
in the :term:`graph` must be completed at runtime. If a task
1570-
:term:`finishes <finished task>` without completing its required
1571+
achieves a :term:`final status` without completing its required
15711572
outputs, the :term:`scheduler` will keep it in the
15721573
:term:`n=0 window <n-window>` pending user intervention.
15731574

@@ -1581,8 +1582,9 @@ Glossary
15811582
stalled state
15821583
In a stalled workflow, there is nothing more the scheduler can do,
15831584
but it stays up for a while awaiting manual intervention because
1584-
the presence of :term:`incomplete <output completion>` tasks in
1585-
the :term:`n=0 window <n-window>` implies that the workflow has not successfully
1585+
the presence of :term:`incomplete <output completion>` tasks, or
1586+
partially satisfied tasks, in the :term:`n=0 window <n-window>`
1587+
implies that the workflow has not successfully
15861588
run to :term:`completion <workflow completion>`.
15871589

15881590
Stalls are usually, but not always, caused by unexpected task failures:

src/user-guide/running-workflows/reflow.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ Special Case: Triggering ``n=0`` Tasks
128128

129129
- Triggering a task with a submitted or running job has no effect
130130
(it is already triggered).
131-
- Triggering other :term:`active tasks <active task>` (including
132-
:term:`incomplete <output completion>`
133-
:term:`finished <finished task>` tasks) queues them to run in the same flow.
131+
- Triggering other :term:`active tasks <active task>`, including
132+
:term:`incomplete <output completion>` tasks with a :term:`final status`,
133+
queues them to run in the same flow.
134134

135135

136136
.. _flow-merging:
@@ -145,7 +145,7 @@ of itself (same task ID) already there, the two will merge and carry both
145145
Flow merging is necessary because :term:`active <active task>` task IDs
146146
must be unique.
147147

148-
If original task instance is :term:`finished <finished task>` but
148+
If original task instance has a :term:`final status` but is
149149
:term:`incomplete <output completion>` the merged task will be reset to
150150
run again without manual intervention.
151151

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ alive for 1 hour (by default) awaiting user intervention
2121
to allow the workflow to continue.
2222

2323
A stall can be caused by tasks with partially satisfied
24-
prerequisites or tasks that finished incomplete. However,
25-
partially satisfied prerequisites normally result from
26-
upstream tasks finishing incomplete.
24+
prerequisites or tasks that achieved a :term:`final status`
25+
with incomplete outputs. Partially satisfied prerequisites
26+
normally result from incomplete tasks with final status
27+
upstream in the graph.
2728

2829
Restarting a stalled workflow resets the stall timer.
2930

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ In the following example, tasks ``bad`` and ``flaky`` each have 3 retries
538538
configured, with a 10 second delay between. On the final try, ``bad`` fails
539539
again and goes to the ``failed`` state, while ``flaky`` succeeds and triggers
540540
task ``whizz`` downstream. The scheduler will then stall because
541-
``bad`` finished with incomplete outputs.
541+
``bad`` failed (which is a :term:`final status`) with incomplete outputs.
542542

543543
.. code-block:: cylc
544544

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1549,22 +1549,20 @@ Required Outputs
15491549
:term:`optional <optional output>` (marked with ``?`` in the graph).
15501550

15511551
Tasks are expected to complete required outputs at runtime, but
1552-
they can finish without completing optional outputs.
1552+
they don't have to complete optional outputs.
15531553

15541554
This allows the scheduler to correctly diagnose
15551555
:term:`workflow completion`. [2]_
15561556

1557-
Tasks that :term:`finish <finished task>` without completing their
1557+
Tasks that achieve a :term:`final status` without completing their
15581558
outputs [3]_ are retained in the :term:`n=0 window <n-window>` pending user
15591559
intervention, e.g. to be retriggered after a bug fix.
15601560

15611561
.. note::
1562-
Tasks that finish without completing their outputs will raise a warning
1563-
and stall the workflow when there is nothing else for the scheduler to
1564-
run. to do (see
1565-
1566-
:ref:`workflow completion`). They also count toward the :term:`runahead
1567-
limit`, because they may run again once dealt with.
1562+
Tasks that achieve a final status without completing their outputs will
1563+
raise a warning and stall the workflow when there is nothing else for
1564+
the scheduler to run (see :ref:`workflow completion`). They also count
1565+
toward the :term:`runahead limit`, because they may run again once dealt with.
15681566

15691567
This graph says task ``bar`` should trigger if ``foo`` succeeds:
15701568

@@ -1573,7 +1571,7 @@ This graph says task ``bar`` should trigger if ``foo`` succeeds:
15731571
foo => bar # short for "foo:succeed => bar"
15741572
15751573
Additionally, ``foo`` is required to succeed, because its success is not marked
1576-
as optional. If ``foo`` :term:`finishes <finished task>` without succeeding the
1574+
as optional. If ``foo`` achieves a :term:`final status` without succeeding the
15771575
scheduler will not run ``bar``, and ``foo`` will be retained
15781576
in :term:`n=0 <n-window>` pending user intervention.
15791577

@@ -1676,7 +1674,8 @@ following graph, ``foo`` is required to succeed, but it doesn't matter whether
16761674
.. note::
16771675

16781676
Optional outputs do not affect *triggering*. They just tell the scheduler
1679-
what to do with the task if it finishes without completing the output.
1677+
what to do with the task if it reaches a :term:`final status` without
1678+
completing the output.
16801679

16811680
This graph triggers ``bar`` if ``foo`` succeeds, and does not trigger
16821681
``bar`` if ``foo`` fails:

0 commit comments

Comments
 (0)