doc: optimize the comment of the Request.Done method #1454
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
erikdubbelboer
requested changes
Dec 18, 2022
server.go
Outdated
| @@ -2697,6 +2697,9 @@ func (ctx *RequestCtx) Deadline() (deadline time.Time, ok bool) { | |||
| // Done returns a channel that's closed when work done on behalf of this | |||
| // context should be canceled. Done may return nil if this context can | |||
| // never be canceled. Successive calls to Done return the same value. | |||
| // | |||
| // Note: Because creating a new channel for every request is just too expensive so | |||
There was a problem hiding this comment.
Suggested change
| // Note: Because creating a new channel for every request is just too expensive so | |
| // Note: Because creating a new channel for every request is just too expensive, |
server.go
Outdated
| @@ -2707,6 +2710,9 @@ func (ctx *RequestCtx) Done() <-chan struct{} { | |||
| // If Done is closed, Err returns a non-nil error explaining why: | |||
| // Canceled if the context was canceled (via server Shutdown) | |||
| // or DeadlineExceeded if the context's deadline passed. | |||
| // | |||
| // Note: Because creating a new channel for every request is just too expensive so | |||
There was a problem hiding this comment.
Suggested change
| // Note: Because creating a new channel for every request is just too expensive so | |
| // Note: Because creating a new channel for every request is just too expensive, |
li-jin-gou
force-pushed
the
doc/ctx_doc
branch
from
5f9ed29
to
8692552
Compare
li-jin-gou
force-pushed
the
doc/ctx_doc
branch
from
8692552
to
095e324
Compare
done |
|
Thanks! |
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.
PR for #1219