Skip to content

Commit f3e9d62

Browse files
authored
Amend workflow events docs (#840)
1 parent d337e13 commit f3e9d62

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

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

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Workflow Events
1717

1818
There are two types of event in Cylc:
1919

20-
* workflow events e.g. ``startup`` and ``shutdown``, which pertain to the :term:`scheduler`
20+
* workflow events e.g. ``startup`` and ``shutdown``, which pertain to the :term:`scheduler`
2121
* task events e.g. ``submitted`` and ``failed``, which pertain to :term:`tasks <task>`.
2222

2323
This section covers workflow events, for
@@ -66,7 +66,16 @@ Some workflow events have related configurations e.g. for setting the timeout.
6666
:Event Handler: `abort handlers`
6767

6868
The scheduler shut down early with error status, due to a fatal error
69-
condition or a configured timeout.
69+
condition.
70+
71+
.. note::
72+
73+
Not to be confused with ``abort on <event>`` settings.
74+
The ``abort`` event is not raised when any such configured event occurs.
75+
76+
.. versionchanged:: 8.0.0
77+
78+
This event was previously called ``aborted``.
7079

7180
.. describe:: workflow timeout
7281

@@ -79,7 +88,7 @@ Some workflow events have related configurations e.g. for setting the timeout.
7988
The timer starts counting down at scheduler startup. It resets on workflow
8089
restart.
8190

82-
Note, the ``abort`` event is not raised by "Abort On Event" handlers.
91+
.. versionadded:: 8.0.0
8392

8493
.. describe:: stall
8594

@@ -90,6 +99,10 @@ Some workflow events have related configurations e.g. for setting the timeout.
9099

91100
E.G. a task failure is blocking the pathway through the graph.
92101

102+
.. versionchanged:: 8.0.0
103+
104+
This event was previously called ``stalled``.
105+
93106
.. describe:: stall timeout
94107

95108
:Configuration: `stall timeout`
@@ -98,6 +111,10 @@ Some workflow events have related configurations e.g. for setting the timeout.
98111

99112
The workflow timed out after stalling.
100113

114+
.. versionchanged:: 8.0.0
115+
116+
This event was previously called ``timeout``.
117+
101118
.. describe:: inactivity timeout
102119

103120
:Configuration: `inactivity timeout`
@@ -110,6 +127,10 @@ Some workflow events have related configurations e.g. for setting the timeout.
110127
This can be useful for system administrators to help catch workflows which
111128
have become stalled on external conditions or system issues.
112129

130+
.. versionchanged:: 8.0.0
131+
132+
This event was previously called ``inactivity``.
133+
113134
.. describe:: restart timeout
114135

115136
:Configuration: `restart timeout`
@@ -118,6 +139,8 @@ Some workflow events have related configurations e.g. for setting the timeout.
118139
have nothing to do so will shut down. This timeout gives the user a grace
119140
period in which to trigger new tasks to continue the workflow run.
120141

142+
.. versionadded:: 8.2.0
143+
121144
.. cylc-scope::
122145

123146
Mail Events

0 commit comments

Comments
 (0)