Merge pull request cylc#6084 from MetRonnie/xrandom

Improve xrandom validate function docstring
hjoliver · Apr 25, 2024 · 6f8ce38 · 6f8ce38
2 parents d559cd6 + 91604ac
commit 6f8ce38
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/cylc/flow/xtriggers/xrandom.py b/cylc/flow/xtriggers/xrandom.py
@@ -100,9 +100,12 @@ def xrandom(
 
 
 def validate(args: Dict[str, Any]):
-    """Validate and manipulate args parsed from the workflow config.
+    """Validate the args that xrandom is called with.
+
+    Cylc calls this function automatically when parsing the workflow.
+
+    Here we specify the rules for args are:
 
-    The rules for args are:
     * percent: Must be 0 ≤ x ≤ 100
     * secs: Must be an integer.
     """