From 2b695ab0376c90396f51cd7b906c101bfa6d3857 Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Tue, 30 Apr 2024 14:16:30 +0100 Subject: [PATCH] docs: reference active tasks entry in the glossary --- cylc/flow/cfgspec/workflow.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/cylc/flow/cfgspec/workflow.py b/cylc/flow/cfgspec/workflow.py index a2f64f4dac5..b4b67cb4587 100644 --- a/cylc/flow/cfgspec/workflow.py +++ b/cylc/flow/cfgspec/workflow.py @@ -644,7 +644,7 @@ def get_script_common_text(this: str, example: Optional[str] = None): ''') Conf('runahead limit', VDR.V_STRING, 'P4', desc=''' The runahead limit prevents a workflow from getting too far ahead - of the oldest :term:`active cycle`. + of the oldest cycle with :term:`active tasks `. A cycle is considered to be active if it contains any :term:`active` tasks. @@ -686,7 +686,8 @@ def get_script_common_text(this: str, example: Optional[str] = None): Configuration of internal queues of tasks. This section will allow you to limit the number of simultaneously - active tasks (submitted or running) by assigning tasks to queues. + :term:`active tasks ` (submitted or running) by + assigning tasks to queues. By default, a single queue called ``default`` is defined, with all tasks assigned to it and no limit to the number of those @@ -712,8 +713,8 @@ def get_script_common_text(this: str, example: Optional[str] = None): Section heading for configuration of a single queue. ''') as Queue: Conf('limit', VDR.V_INTEGER, 0, desc=''' - The maximum number of active tasks allowed at any one - time, for this queue. + The maximum number of :term:`active tasks ` + allowed at any one time, for this queue. If set to 0 this queue is not limited. ''') @@ -728,8 +729,8 @@ def get_script_common_text(this: str, example: Optional[str] = None): The default queue for all tasks not assigned to other queues. '''): Conf('limit', VDR.V_INTEGER, 100, desc=''' - Controls the total number of active tasks in the default - queue. + Controls the total number of + :term:`active tasks ` in the default queue. .. seealso::