From 30d9b7f548a523f02e94138a1360d6e4becebab4 Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Wed, 7 Feb 2024 13:08:40 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> --- src/user-guide/writing-workflows/scheduler.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/user-guide/writing-workflows/scheduler.rst b/src/user-guide/writing-workflows/scheduler.rst index ebd438ad56..67bff7bda2 100644 --- a/src/user-guide/writing-workflows/scheduler.rst +++ b/src/user-guide/writing-workflows/scheduler.rst @@ -15,9 +15,12 @@ workflows. Workflow Events --------------- -Cylc supports workflow events which pertain to the :term:`scheduler` e.g. -``startup`` and ``shutdown`` and task events e.g. ``submitted`` and ``failed`` -which pertain to :term:`tasks `. This section covers workflow events, for +There are two types of event in Cylc: + +* workflow events e.g. ``startup`` and ``shutdown``, which pertain to the :term:`scheduler` +* task events e.g. ``submitted`` and ``failed``, which pertain to :term:`tasks `. + +This section covers workflow events, for task events see :ref:`user_guide.runtime.task_event_handling`. .. rubric:: Event Handlers @@ -76,6 +79,8 @@ Some workflow events have related configurations e.g. for setting the timeout. The timer starts counting down at scheduler startup. It resets on workflow restart. + Note, the `abort` event is not related to "Abort On Event" handlers. + .. describe:: stall :Event Handler: `stall handlers`