Skip to content

Commit

Permalink
docs: reference active tasks entry in the glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-sanders committed Apr 30, 2024
1 parent f416021 commit 2b695ab
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions cylc/flow/cfgspec/workflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <active task>`.
A cycle is considered to be active if it contains any
:term:`active` tasks.
Expand Down Expand Up @@ -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 <active task>` (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
Expand All @@ -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 <active task>`
allowed at any one time, for this queue.
If set to 0 this queue is not limited.
''')
Expand All @@ -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 <active task>` in the default queue.
.. seealso::
Expand Down

0 comments on commit 2b695ab

Please sign in to comment.