Skip to content

Commit d5e6dad

Browse files
committed
Wording from core protos
1 parent 29e184c commit d5e6dad

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

temporalio/workflow.py

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5118,29 +5118,25 @@ def _to_proto(self) -> temporalio.bridge.proto.common.VersioningIntent.ValueType
51185118

51195119

51205120
class NexusOperationCancellationType(IntEnum):
5121-
"""Defines behavior of the parent workflow when CancellationScope that wraps Nexus operation
5122-
is canceled. The result of the cancellation independently of the type is a
5123-
CanceledFailure thrown from the Nexus operation method. If the caller exits without waiting, the
5124-
cancellation request may not be delivered to the handler, regardless of indicated cancellation
5125-
type.
5126-
"""
5121+
"""Controls at which point to report back to lang when a nexus operation is
5122+
cancelled."""
51275123

5128-
WAIT_COMPLETED = 0
5129-
"""Wait for operation completion. Operation may or may not complete as cancelled. Default."""
5124+
WAIT_CANCELLATION_COMPLETED = 0
5125+
"""Wait for operation cancellation completion. Default."""
51305126

51315127
ABANDON = 1
5132-
"""Do not request cancellation of the operation."""
5128+
"""Do not request cancellation of the nexus operation if already scheduled."""
51335129

51345130
TRY_CANCEL = 2
5135-
"""Initiate a cancellation request and immediately report cancellation to the caller. Note that it
5136-
doesn't guarantee that cancellation is delivered to the operation handler if the caller exits
5137-
before the delivery is done.
5138-
"""
5139-
5140-
WAIT_REQUESTED = 3
5141-
"""Request cancellation of the operation and wait for confirmation that the request was received.
5142-
Doesn't wait for actual cancellation.
5143-
"""
5131+
"""Initiate a cancellation request for the Nexus operation and immediately report
5132+
cancellation to the caller. Note that it doesn't guarantee that cancellation is
5133+
delivered to the operation if calling workflow exits before the delivery is done. If
5134+
you want to ensure that cancellation is delivered to the operation, use
5135+
WAIT_CANCELLATION_REQUESTED."""
5136+
5137+
WAIT_CANCELLATION_REQUESTED = 3
5138+
"""Request cancellation of the operation and wait for confirmation that the request
5139+
was received."""
51445140

51455141

51465142
class NexusClient(ABC, Generic[ServiceT]):

0 commit comments

Comments
 (0)