Skip to content

Fix startUpdate JavaDoc: clarify blocking behavior based on waitForStage - #2992

Open
sachinsharma3191 wants to merge 2 commits into
temporalio:mainfrom
sachinsharma3191:fix/2578-startUpdate-javadoc-async
Open

Fix startUpdate JavaDoc: clarify blocking behavior based on waitForStage#2992
sachinsharma3191 wants to merge 2 commits into
temporalio:mainfrom
sachinsharma3191:fix/2578-startUpdate-javadoc-async

Conversation

@sachinsharma3191

@sachinsharma3191 sachinsharma3191 commented Aug 10, 2026

Copy link
Copy Markdown

What was changed

  • Replaced misleading "asynchronously" wording in all startUpdate and startUpdateWithStart JavaDoc comments (21 overloads)
  • Added note that the method blocks until the waitForStage specified in the options is reached
  • Fixed @param arg5 typo: "firth" → "fifth" in five-argument overload, "firth" → "fifth" in six-argument overload

Why?

Issue #2578: the startUpdate JavaDoc says "asynchronously" but the method actually blocks until the waitForStage specified in UpdateOptions is reached. When waitForStage is COMPLETED, the call blocks until the update finishes. This is confusing for users who expect non-blocking behavior based on the doc.

Checklist

  • Doc-only change — no behavioral changes
  • Verified all 21 overloads updated consistently
  • No remaining incorrect "asynchronously" in startUpdate/startUpdateWithStart JavaDocs

Fixes #2578

The JavaDoc for all startUpdate and startUpdateWithStart overloads
incorrectly described the methods as "asynchronous". When waitForStage
is set to COMPLETED, startUpdate blocks until the update finishes.

Replace "asynchronously" with a note that the method blocks until
the waitForStage specified in the options is reached.

Fixes temporalio#2578
@sachinsharma3191
sachinsharma3191 requested a review from a team as a code owner August 10, 2026 01:12
@dplyukhin

Copy link
Copy Markdown
Contributor

Thanks for the contrib. Is this PR still in progress? It has mistakes and the checklist isn't checked off. If in progress, please convert to a draft PR. Please also update the PR description to use the template we provide. Does this address any outstanding issues?

@dplyukhin

Copy link
Copy Markdown
Contributor

Please also take note of the contributing guidelines - particularly AI-generated PRs.

@sachinsharma3191

Copy link
Copy Markdown
Author

Thanks for the review! I've addressed the feedback:

  1. Fixed the mistake@param arg5 in the six-argument startUpdate overload was incorrectly changed to "sixth" instead of "fifth". Pushed a fix.
  2. Updated PR description to use the repo's template format (What was changed / Why? / Checklist).
  3. Checked off the checklist.

This addresses issue #2578. I've reviewed the changes thoroughly — it's a doc-only change across 21 startUpdate/startUpdateWithStart overloads.

@sachinsharma3191

Copy link
Copy Markdown
Author

@dplyukhin This PR is ready for review — doc-only change across 21 startUpdate/startUpdateWithStart overloads (fixes #2578). Could you take a look when you get a chance? Thanks!

@dplyukhin

Copy link
Copy Markdown
Contributor

Your PRs are low-priority and triaged. Please do not send reminders or I'll have to close the PR. It's not a good use of maintainers' time. I'd like to get to them when I have time.

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