Tweak UpdateWorfklow docs #1745
Merged
Conversation
This file contains 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
dandavison
force-pushed
the
update-docs
branch
from
c38a882 to
7ae92c1
Compare
client/client.go
Outdated
| // returns a handle to the update. The call will block until the update | ||
| // has reached the WaitForStage in the options. Note that this means | ||
| // that the call will not return successfully until the update has been | ||
| // delivered to the worker service. Errors returned from the update |
There was a problem hiding this comment.
Suggested change
| // delivered to the worker service. Errors returned from the update | |
| // delivered to a worker. Errors returned from the update |
I would avoid the word worker service here since it has a different meaning in a Temporal cluster https://docs.temporal.io/clusters. Here we mean the user worker.
There was a problem hiding this comment.
Thanks, I agree "a worker" is better than "the/your worker service". (I don't think I agree that "worker service" should in general be reserved as referring to the internal server implementation detail though)
Quinn-With-Two-Ns
approved these changes
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Some proposed edits to the
UpdateWorkflowdocstring. These make it consistent with theUpdateWithStartWorkflowdocstring, and also make some other edits that I think are slight improvements, but open for discussion.