From ab8a006f52f9ccb4662f8c0e997dabc84011dce7 Mon Sep 17 00:00:00 2001 From: Aleksei Gagarin Date: Fri, 10 May 2024 23:47:38 +0400 Subject: [PATCH] docs(client): update description for WorkflowStubInterface::startUpdate() method (#429) --- src/Client/WorkflowStubInterface.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/Client/WorkflowStubInterface.php b/src/Client/WorkflowStubInterface.php index 5f2215336..cf640053c 100644 --- a/src/Client/WorkflowStubInterface.php +++ b/src/Client/WorkflowStubInterface.php @@ -94,9 +94,14 @@ public function query(string $name, ...$args): ?ValuesInterface; public function update(string $name, ...$args): ?ValuesInterface; /** - * Asynchronously update a workflow execution by invoking its update handler and returning a + * Update a workflow execution by invoking its update handler and returning a * handle to the update request. * + * By default, WaitPolicy is set to {@see \Temporal\Client\Update\LifecycleStage::StageAccepted}, + * which means that the handle will return immediately after successful validation of the Update call. + * However, also note that the processing Workflow worker must be available. Otherwise, the request + * may block indefinitely or fail due to a timeout. + * * Usually an update handler is a method annotated with the {@see UpdateMethod} attribute. * * @param non-empty-string|UpdateOptions $nameOrOptions Name of the update handler or update options.