Skip to content

Clarify startUpdate JavaDoc on blocking behavior - #3174

Open
sdjcse wants to merge 4 commits into
temporalio:mainfrom
sdjcse:issue-2578-startupdate-javadoc
Open

sdjcse wants to merge 4 commits into
temporalio:mainfrom
sdjcse:issue-2578-startupdate-javadoc

Conversation

@sdjcse

@sdjcse sdjcse commented Oct 28, 2026 •

Copy link
Copy Markdown

Fixes #2578

What changed?

  • Removed "asynchronously" from the JavaDoc of every WorkflowClient.startUpdate and startUpdateWithStart overload (21 in total).

Why?

startUpdate makes a blocking gRPC call with the caller's wait policy, so the "asynchronously" wording was misleading.

Breaking changes?

None. JavaDoc only, no signature or behavior changes.

Server PR

Not applicable.

🤖 Generated with Claude Code

@sdjcse
sdjcse requested a review from a team as a code owner October 28, 2026 09:59
@sdjcse
sdjcse force-pushed the issue-2578-startupdate-javadoc branch from 3ec9c41 to 0d81b32 Compare October 28, 2026 10:08
* Start a zero argument update workflow request asynchronously.
* Start a zero argument update workflow request.
*
* <p>This call may block until the update reaches the stage set with {@link

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this paragraph it is partially incorrect and partially redundant. The issue was just to remove the word asynchronously

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the paragraph in 53f73df, so the change now only drops "asynchronously".

sdjcse and others added 3 commits November 17, 2026 08:54
The startUpdate and startUpdateWithStart overloads documented the call
as asynchronous. They actually return once the update reaches the
wait-for stage set in UpdateOptions, so the call blocks until the
update finishes when that stage is COMPLETED.

Fixes temporalio#2578

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The previous wording said startUpdate blocks until the update finishes
when the wait-for stage is COMPLETED. The invoker stops re-polling once
the update is at least accepted, so the call can return earlier with a
handle that has no outcome yet.

Describe the call as possibly blocking up to the server's wait limit
and point callers at the returned handle for the remaining wait.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Review feedback noted the paragraph was partially incorrect and
redundant with the UpdateOptions documentation. The issue only asked
to remove the word "asynchronously", so keep the change to that.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Quinn-With-Two-Ns
Quinn-With-Two-Ns force-pushed the issue-2578-startupdate-javadoc branch from 53f73df to d00c3d6 Compare November 17, 2026 15:54
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

startUpdate JavaDoc says "asynchronously" when it may not be

2 participants