xtriggers: doc change (#6152)

cylc · Jun 18, 2024 · 3962f3d · 3962f3d
1 parent 586907e
commit 3962f3d
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/cylc/flow/xtriggers/workflow_state.py b/cylc/flow/xtriggers/workflow_state.py
@@ -59,8 +59,17 @@ def workflow_state(
         satisfied:
             True if ``satisfied`` else ``False``.
         result:
-            Dict of workflow, task, point, offset,
-            status, message, trigger, flow_num, run_dir
+            Dict containing the keys:
+
+            * ``workflow``
+            * ``task``
+            * ``point``
+            * ``offset``
+            * ``status``
+            * ``message``
+            * ``trigger``
+            * ``flow_num``
+            * ``run_dir``
 
     .. versionchanged:: 8.3.0