Fix startUpdate JavaDoc: clarify blocking behavior based on waitForStage - #2992
Open
sachinsharma3191 wants to merge 1 commit into
Open
Fix startUpdate JavaDoc: clarify blocking behavior based on waitForStage#2992sachinsharma3191 wants to merge 1 commit into
sachinsharma3191 wants to merge 1 commit into
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
startUpdateandstartUpdateWithStartJavaDoc commentswaitForStagespecified in the options is reached (e.g.,COMPLETEDcauses the call to block until the update finishes)@param arg5descriptionsTest plan
Fixes #2578