From 6dbe2f42d53f712b14475d5c56819c13825360ef Mon Sep 17 00:00:00 2001 From: Dan Davison Date: Mon, 6 Nov 2023 16:34:41 +0000 Subject: [PATCH] Fix docstring (#414) --- temporalio/client.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/temporalio/client.py b/temporalio/client.py index ee99d1ea..f0977c0a 100644 --- a/temporalio/client.py +++ b/temporalio/client.py @@ -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: