server: clarify documentation around setting and sending headers and ServerStream errors #5302
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
…ServerStream errors
menghanl
suggested changes
Apr 7, 2022
server.go
Outdated
| // - An RPC status is sent out (error or success). This occurs when the handler | ||
| // returns. | ||
| // | ||
| // SetHeader will fail if called after any of these events. |
There was a problem hiding this comment.
Make it more clear what these events are?
"the events above"?
Or move it above, right after the "send out" section
All the metadata will be sent out when one of the following happens, and SetHeader will fail if called after any of the events:
server.go
Outdated
| // SetHeader will fail if called after any of these events. | ||
| // | ||
| // The error returned is compatible with the status package. However, the | ||
| // status will often not match the status seen by the client application, and |
There was a problem hiding this comment.
the status code will often not
And did you want to say that the meanings of the codes are different from the client side? Or just that this code might be different from what the client functions return?
There was a problem hiding this comment.
Clarified. I intended the latter. The "meaning" of our codes is pretty variable already.
menghanl
approved these changes
Apr 8, 2022
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.
External documentation: please nit-pick.
RELEASE NOTES: