blob: document storing a ctx in blob.Writer #298
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
vangent
requested changes
Aug 9, 2018
blob/blob.go
Outdated
| @@ -59,6 +59,12 @@ type Writer struct { | |||
|
|
|||
| // These fields exist only when w is not created in the first place when | |||
| // NewWriter is called. | |||
| // | |||
| // A ctx is stored in the Writer since we need to pass it into NewTypedWriter | |||
| // when we finished detecting the content type of the object and create the | |||
There was a problem hiding this comment.
Nit: finished -> finish, "done passing it" -> "passed it".
| @@ -59,6 +59,12 @@ type Writer struct { | |||
|
|
|||
| // These fields exist only when w is not created in the first place when | |||
| // NewWriter is called. | |||
| // | |||
There was a problem hiding this comment.
For the bug, I meant that we should document this in the public API. I.e., in NewWriter, which takes a ctx, we should document that the context must remain open until after the returned Writer is closed.
There was a problem hiding this comment.
Ack, added comment there.
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.
Fixes #274