Skip to content

Commit

Permalink
Xtrigger doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
MetRonnie committed Jun 17, 2024
1 parent 587a2b7 commit 061a8be
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
3 changes: 3 additions & 0 deletions cylc/flow/xtriggers/wall_clock.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ def wall_clock(offset: str = 'PT0S', sequential: bool = True):
Wall-clock xtriggers are run sequentially by default.
See :ref:`Sequential Xtriggers` for more details.
.. versionchanged:: 8.3.0
The ``sequential`` argument was added.
"""
# NOTE: This is just a placeholder for the actual implementation.
# This is only used for validating the signature and for autodocs.
Expand Down
9 changes: 8 additions & 1 deletion cylc/flow/xtriggers/workflow_state.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def workflow_state(
If the status or output has been achieved, return {True, result}.
Arg:
Args:
workflow_task_id:
ID (workflow//point/task:selector) of the target task.
offset:
Expand All @@ -62,6 +62,13 @@ def workflow_state(
Dict of workflow, task, point, offset,
status, message, trigger, flow_num, run_dir
.. versionchanged:: 8.3.0
The ``workflow_task_id`` argument was introduced to replace the
separate ``workflow``, ``point``, ``task``, ``status``, and ``message``
arguments (which are still supported for backwards compatibility).
The ``flow_num`` argument was added. The ``cylc_run_dir`` argument
was renamed to ``alt_cylc_run_dir``.
"""
poller = WorkflowPoller(
workflow_task_id,
Expand Down

0 comments on commit 061a8be

Please sign in to comment.