Skip to content

Commit a6c43ed

Browse files
authored
Merge pull request #820 from hjoliver/xtrigger-redoc
Redo xtrigger docs, with set xtriggers
1 parent 13a598e commit a6c43ed

File tree

4 files changed

+483
-276
lines changed

4 files changed

+483
-276
lines changed

src/glossary.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,10 @@ Glossary
6969
don't get overwritten.
7070

7171
active task
72+
active window
7273
Active tasks are those tasks held in memory to feed
73-
the scheduling algorithm. They form the ``n=0`` :term:`n-window`,
74-
so are always visible in the GUI.
74+
the scheduling algorithm. They form the ``n=0`` or *active*
75+
:term:`window<n-window>`, so are always visible in the GUI.
7576

7677
Active tasks include:
7778

@@ -1686,6 +1687,16 @@ Glossary
16861687
.. seealso::
16871688
* :ref:`user-guide-reflow`
16881689

1690+
child
1691+
parent
1692+
parentless
1693+
The upstream and downstream tasks in a dependency pair may be referred
1694+
to, respectively, as parent and child tasks. Tasks that have parents are
1695+
spawned into the :term:`active window` of the workflow as soon as the
1696+
first of their task prerequisites is satisfied by a parent. Parentless
1697+
tasks don't have any task prerequisites, so they get spawned automatically
1698+
out to the :term:`runahead limit`.
1699+
16891700

16901701
flow number
16911702
Flow numbers are integers passed down from parent task to child task in

src/user-guide/troubleshooting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,8 @@ It's waiting for upstream tasks to produce their required outputs:
346346

347347
Such tasks will be reported as having unsatisfied dependencies.
348348
It's waiting for external events:
349-
:ref:`Xtriggers <Section External Triggers>` and
350-
:ref:`ext-triggers <Old-Style External Triggers>`
349+
:ref:`Xtriggers <user_guide.xtriggers>` and
350+
:ref:`ext-triggers <user_guide.ext-triggers>`
351351
can be used to make tasks wait for events
352352
external to the workflow, such as the progress of task in other workflows
353353
or the :ref:`real-world time <Built-in Clock Triggers>`.

0 commit comments

Comments
 (0)