docs: clarify Upgrade blocks until child responds - #88
Open
Solaris-star wants to merge 1 commit into
Open
Conversation
The previous one-liner ("triggers an upgrade") reads like a fire-and-forget
call. Upgrade waits on the child response channel and returns an error if
the child fails or the process is already terminating/upgraded.
Fixes cloudflare#81
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.
Description
Upgradewas documented as "triggers an upgrade", which sounds fire-and-forget. The method actually blocks on the child response channel and returns an error if the child fails or the process is already terminating/upgraded.Fix
Expand the godoc to state that
Upgradewaits for the child and returns the outcome.Tests
Docs-only.
Linked Issue
Closes #81