Fix startUpdate JavaDoc: clarify blocking behavior based on waitForStage - #2992
Fix startUpdate JavaDoc: clarify blocking behavior based on waitForStage#2992sachinsharma3191 wants to merge 2 commits into
Conversation
|
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? |
|
Please also take note of the contributing guidelines - particularly AI-generated PRs. |
|
Thanks for the review! I've addressed the feedback:
This addresses issue #2578. I've reviewed the changes thoroughly — it's a doc-only change across 21 |
|
@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! |
|
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. |
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
|
sachinsharma seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
1 similar comment
|
sachinsharma seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
What was changed
startUpdateandstartUpdateWithStartJavaDoc comments (21 overloads)waitForStagespecified in the options is reached@param arg5typo: "firth" → "fifth" in five-argument overload, "firth" → "fifth" in six-argument overloadWhy?
Issue #2578: the
startUpdateJavaDoc says "asynchronously" but the method actually blocks until thewaitForStagespecified inUpdateOptionsis reached. WhenwaitForStageisCOMPLETED, the call blocks until the update finishes. This is confusing for users who expect non-blocking behavior based on the doc.Checklist
Fixes #2578