clarify CloseSend vs CloseAndRecv; better formatting #2071
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
dfawley
reviewed
May 18, 2018
stream.go
Outdated
| // release of resources. | ||
| // - Bidirectional clients should call Close and then call Recv until a non-nil | ||
| // error is returned. | ||
| // - Unidirectional clients should call CloseAndRecv. Note that CloseSend may not |
There was a problem hiding this comment.
"Unidirectional" is ambiguous. I think you want something like "For client streaming RPCs, clients should call ..."
There was a problem hiding this comment.
"client streaming RPCs" could include bidirectional, which does not have CloseAndRecv right?
Could you clarify how unidirectional is ambiguous? Are you referring to the fact that both clients and servers can unidirectionally stream?
If so, how about:
- "For unidirectional RPCs, clients should ..."
- "For bidirectional RPCs, clients and servers should ..."
There was a problem hiding this comment.
Why not "For client-streaming RPCs..."? We have historically called the two unidirectional streaming RPCs "client-streaming" and "server-streaming".
dfawley
reviewed
May 18, 2018
stream.go
Outdated
| // error is returned. | ||
| // - Unidirectional clients should call CloseAndRecv. Note that CloseSend may not | ||
| // release all goroutines; CloseAndRecv guarantees release of resources. | ||
| // - Bidirectional clients should call Close and then repeatedly call Recv until |
There was a problem hiding this comment.
"Bidirectional or server-streaming clients"?
|
@dfawley PTAL |
dfawley
approved these changes
May 29, 2018
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.
This may be overly verbose - I'd love to know if there's a better way to say this.
Inspired by CovenantSQL/CovenantSQL#18 via golang/go#7873.