Clear up documentation on status.FromError #4864
Closed
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
Documentation stated > // Otherwise, ok is false and a Status is returned with codes.Unknown and > // the original error message. This read as `ok` being `false` when `err` is not nil. However, `ok` is only `false` when `err` is not nil _and_ could not be parsed (though the `GRPCStatus()` method). Clarified.
|
|
|
This is not the first time someone was confused by the wording of this, and we've made some changes here in the past to try to help, apparently in vain. I've tried to make this extremely clear via #4880. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Documentation stated
This read as
okbeingfalsewhenerris not nil. However,okis onlyfalsewhenerris not nil and could not be parsed (though theGRPCStatus()method).Clarified.
RELEASE NOTES: none