Skip to content

Commit 3075b02

Browse files
author
Alan Christie
committed
docs: Doc tweak
1 parent ee1e610 commit 3075b02

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

workflow/workflow_abc.py

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,28 @@ class LaunchParameters:
1515
The launching user API token is the second element when the request header's
1616
'Authorization' value is split on white-space."""
1717

18-
# The Project UUID to launch the instance in
18+
# The Project UUID of the project to launch the instance in
1919
project_id: str
2020
# A symbolic name of the Instance
2121
name: str
22-
# The user name of the person launching the Instance/Workflow
22+
# The user name of the person launching the Instance (Workflow step)
2323
launching_user_name: str
2424
# The API Access token provided by the User
2525
launching_user_api_token: str
2626
# The specification, which can contain 'variables'
2727
specification: dict[str, Any]
28-
# An alternative way to passing variables to the specification.
29-
# If used it will replace any 'variables' key in the specification.
28+
# An alternative way to pass variables to the specification.
29+
# If used it will replace any 'variables' already present in the specification.
3030
specification_variables: dict[str, Any] | None = None
3131
# A string. In DM v4 converted to a boolean and set in the
32-
# instance Pod as a label.
32+
# instance Pod as a label. Setting this means the Instances
33+
# that are created will not be automatically removed by the Job operator.
3334
debug: str | None = None
34-
# The RunningWorkflow UUID
35+
# The RunningWorkflow UUID.
36+
# Required if the Instance is part of a Workflow step.
3537
running_workflow_id: str | None = None
36-
# The RunningWorkflowStep UUID
38+
# The RunningWorkflowStep UUID.
39+
# Required if the Instance is part of a Workflow step.
3740
running_workflow_step_id: str | None = None
3841
# The application ID (a custom resource name)
3942
# used to identify the 'type' of Instance to create.
@@ -47,10 +50,13 @@ class LaunchResult:
4750
Any error returned in this object is a launch error, not a Job error."""
4851

4952
# A numeric non-zero error code if an error occurred
50-
# and an optional message
53+
# and an error message if the error number is not zero.
5154
error_num: int = 0
5255
error_msg: str | None = None
53-
# The Instance UUID that was created for you
56+
# The following optional properties
57+
# may not be present if there's a launch error.
58+
#
59+
# The Instance UUID that was created for you.
5460
instance_id: str | None = None
5561
# The Task UUID that is handling the Instance launch
5662
task_id: str | None = None

0 commit comments

Comments
 (0)