Skip to content

Commit 6dbe2f4

Browse files
authored
Fix docstring (#414)
1 parent 063b9bf commit 6dbe2f4

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

temporalio/client.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4107,17 +4107,16 @@ async def result(
41074107
rpc_timeout: Optional[timedelta] = None,
41084108
) -> LocalReturnType:
41094109
"""Wait for and return the result of the update. The result may already be known in which case no network call
4110-
is made. Otherwise the result will be polled for until returned, or until the provided timeout is reached, if
4111-
specified.
4110+
is made. Otherwise the result will be polled for until it is returned.
41124111
41134112
Args:
41144113
rpc_metadata: Headers used on the RPC call. Keys here override client-level RPC metadata keys.
4115-
rpc_timeout: Optional RPC deadline to set for the RPC call. If this elapses, the poll is retried until the
4116-
overall timeout has been reached.
4114+
rpc_timeout: Optional RPC deadline to set for each RPC call. Note: this is the timeout for each
4115+
RPC call while polling, not a timeout for the function as a whole. If an individual RPC times out,
4116+
it will be retried until the result is available.
41174117
41184118
Raises:
41194119
WorkflowUpdateFailedError: If the update failed
4120-
TimeoutError: The specified timeout was reached when waiting for the update result.
41214120
RPCError: Update result could not be fetched for some other reason.
41224121
"""
41234122
if self._known_outcome is not None:

0 commit comments

Comments
 (0)