Skip to content

Commit

Permalink
xrandom: autodoc validate function & remove repeated content
Browse files Browse the repository at this point in the history
  • Loading branch information
MetRonnie committed Apr 25, 2024
1 parent c4a6056 commit 95fb337
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions src/user-guide/writing-workflows/external-triggers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -400,14 +400,8 @@ time (useful for testing the effect of a long-running trigger function
success. The function signature is:

.. automodule:: cylc.flow.xtriggers.xrandom
:members: xrandom

The ``percent`` argument sets the odds of success in any given call;
``secs`` is the number of seconds to sleep before returning; and the
``_`` argument (underscore is a conventional name for a variable
that is not used, in Python) is provided to allow specialization of the
trigger to (for example) task name, task ID, or cycle point (just use
the appropriate string templates in the workflow configuration for this).
:members: xrandom, validate
:member-order: bysource

An example xrandom trigger workflow:

Expand Down

0 comments on commit 95fb337

Please sign in to comment.