Skip to content

Commit 061a8be

Browse files
committed
Xtrigger doc improvements
1 parent 587a2b7 commit 061a8be

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

cylc/flow/xtriggers/wall_clock.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ def wall_clock(offset: str = 'PT0S', sequential: bool = True):
3838
Wall-clock xtriggers are run sequentially by default.
3939
See :ref:`Sequential Xtriggers` for more details.
4040
41+
.. versionchanged:: 8.3.0
42+
43+
The ``sequential`` argument was added.
4144
"""
4245
# NOTE: This is just a placeholder for the actual implementation.
4346
# This is only used for validating the signature and for autodocs.

cylc/flow/xtriggers/workflow_state.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def workflow_state(
3636
3737
If the status or output has been achieved, return {True, result}.
3838
39-
Arg:
39+
Args:
4040
workflow_task_id:
4141
ID (workflow//point/task:selector) of the target task.
4242
offset:
@@ -62,6 +62,13 @@ def workflow_state(
6262
Dict of workflow, task, point, offset,
6363
status, message, trigger, flow_num, run_dir
6464
65+
.. versionchanged:: 8.3.0
66+
67+
The ``workflow_task_id`` argument was introduced to replace the
68+
separate ``workflow``, ``point``, ``task``, ``status``, and ``message``
69+
arguments (which are still supported for backwards compatibility).
70+
The ``flow_num`` argument was added. The ``cylc_run_dir`` argument
71+
was renamed to ``alt_cylc_run_dir``.
6572
"""
6673
poller = WorkflowPoller(
6774
workflow_task_id,

0 commit comments

Comments
 (0)