From 01b52a21ea716f326ed7f8e75a410c95e63ba9ca Mon Sep 17 00:00:00 2001 From: Dan Davison Date: Thu, 5 Dec 2024 21:17:49 -0500 Subject: [PATCH] Tweak UpdateWorfklow docs (#1745) --- client/client.go | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/client/client.go b/client/client.go index 95474689a..cca121ba5 100644 --- a/client/client.go +++ b/client/client.go @@ -831,14 +831,16 @@ type ( // API. If the check fails, an error is returned. CheckHealth(ctx context.Context, request *CheckHealthRequest) (*CheckHealthResponse, error) - // UpdateWorkflow issues an update request to the - // specified workflow execution and returns a handle to the update that - // is running in in parallel with the calling thread. Errors returned - // from the server will be exposed through the return value of - // WorkflowUpdateHandle.Get(). Errors that occur before the - // update is requested (e.g. if the required workflow ID field is - // missing from the UpdateWorkflowOptions) are returned - // directly from this function call. + // UpdateWorkflow issues an update request to the specified workflow and + // returns a handle to the update. The call will block until the update + // has reached the WaitForStage in the options. Note that this means + // that the call will not return successfully until the update has been + // delivered to a worker. Errors returned from the update handler or its + // validator will be exposed through the return value of + // WorkflowUpdateHandle.Get(). Errors that occur before the update is + // delivered to the workflow (e.g. if the required workflow ID field is + // missing from the UpdateWorkflowOptions) are returned directly from + // this function call. // // The errors it can return: // - WorkflowUpdateServiceTimeoutOrCanceledError