Skip to content

Commit 4a3b9aa

Browse files
author
Alan Christie
committed
fix: Fix class typo
1 parent f6924e5 commit 4a3b9aa

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

workflow/workflow_engine.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,8 @@ class StopResult:
4040
_SUCCESS_STOP_RESULT: StopResult = StopResult(error=0, error_msg=None)
4141

4242

43-
class WorkflowValidator:
44-
"""The workflow validator. Typically used from teh context of the API
45-
to check workflow content prior to creation and execution.
46-
"""
43+
class WorkflowEngine:
44+
"""The workflow engine."""
4745

4846
def __init__(
4947
self,
@@ -62,6 +60,11 @@ def handle_pod_message(
6260
) -> HandlePodMessageResult:
6361
"""Given a PodMessage, we use it to identify the Pod (Instance) exit code,
6462
workflow and step and decide what to do next.
63+
64+
Only pod messages relating to workflow instances will be delivered to this method.
65+
The Pod message has an 'instance' property that provides the UUID of
66+
the instance that was run. This can be used to correlate the instance with the
67+
running workflow step.
6568
"""
6669
assert pod_msg
6770

0 commit comments

Comments
 (0)