Skip to content

Fix Workflow Update result docstring #414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Fix Workflow Update result docstring #414

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions temporalio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4107,17 +4107,16 @@ async def result(
rpc_timeout: Optional[timedelta] = None,
) -> LocalReturnType:
"""Wait for and return the result of the update. The result may already be known in which case no network call
is made. Otherwise the result will be polled for until returned, or until the provided timeout is reached, if
specified.
is made. Otherwise the result will be polled for until it is returned.

Args:
rpc_metadata: Headers used on the RPC call. Keys here override client-level RPC metadata keys.
rpc_timeout: Optional RPC deadline to set for the RPC call. If this elapses, the poll is retried until the
overall timeout has been reached.
rpc_timeout: Optional RPC deadline to set for each RPC call. Note: this is the timeout for each
RPC call while polling, not a timeout for the function as a whole. If an individual RPC times out,
it will be retried until the result is available.

Raises:
WorkflowUpdateFailedError: If the update failed
TimeoutError: The specified timeout was reached when waiting for the update result.
RPCError: Update result could not be fetched for some other reason.
"""
if self._known_outcome is not None:
Expand Down