Skip to content

Commit 8e3afc7

Browse files
cfgspec: improve restart timeout docs
1 parent 8b64627 commit 8e3afc7

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

cylc/flow/cfgspec/globalcfg.py

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,14 +370,40 @@
370370
''',
371371
'restart timeout': '''
372372
How long to wait for intervention on restarting a completed workflow.
373-
The timer stops if any task is triggered.
373+
374+
When a workflow reaches the end of the :term:`graph`, it will
375+
:term:`shut down <shutdown>` automatically. We call such workflows
376+
:ref:`completed <workflow completion>` as there are no more tasks for
377+
Cylc to run.
378+
379+
Completed workflows can be caused by:
380+
381+
* Cylc reaching the end of the :term:`graph`.
382+
* The workflow reaching the
383+
:cylc:conf:`flow.cylc[scheduling]final cycle point`.
384+
* The workflow reaching the
385+
:cylc:conf:`flow.cylc[scheduling]stop after cycle point`.
386+
* Tasks being manually removed :ref:`interventions.remove_tasks`.
387+
388+
When you restart a completed workflow, it will detect that there are no
389+
more tasks to run, and shut itself down again. The ``restart timeout``
390+
delays this shutdown for a configured period allowing you to trigger
391+
more task(s) to run.
374392
375393
.. seealso::
376394
377-
:ref:`user_guide.scheduler.workflow_events`
395+
* :ref:`user_guide.scheduler.workflow_events`
396+
* :ref:`workflow completion`
397+
* :ref:`examples.extending-workflow`
378398
379399
.. versionadded:: 8.2.0
380400
401+
.. versionchanged:: 8.5.2
402+
403+
The ``restart timeout`` is now also activated for workflows that
404+
have hit the
405+
:cylc:conf:`flow.cylc[scheduling]stop after cycle point`.
406+
381407
'''
382408
}
383409

0 commit comments

Comments
 (0)