Document System.IO.Compression.Brotli.BrotliDecoder #3379
Merged
Conversation
This file contains hidden or 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
carlossanlop
added
new-content
carlossanlop
requested review from
a team,
BillWagner,
Thraka,
ViktorHofer,
ahsonkhan,
buyaa-n,
ericstj,
gewarren and
tdykstra
tdykstra
approved these changes
Oct 22, 2019
Contributor
tdykstra
left a comment
tdykstra
left a comment
There was a problem hiding this comment.
LGTM aside from a couple of minor suggestions.
ahsonkhan
suggested changes
Oct 24, 2019
Contributor
ahsonkhan
left a comment
ahsonkhan
left a comment
There was a problem hiding this comment.
Left some feedback. Follow other "OperationStatus-returning" API docs and add more details to the remarks for different cases and the guarantees the API makes for different returns (like overlapping buffers, same buffers).
carlossanlop
commented
Oct 25, 2019
Contributor
Author
carlossanlop
left a comment
carlossanlop
left a comment
There was a problem hiding this comment.
Thanks for your comments, @ahsonkhan and @tdykstra . I addressed them but have not commited them. Would you mind taking another look?
carlossanlop
added
changes-addressed
tdykstra
approved these changes
Oct 25, 2019
Contributor
tdykstra
left a comment
tdykstra
left a comment
There was a problem hiding this comment.
Looks good, one additional suggestion.
Co-Authored-By: Tom Dykstra <tdykstra@microsoft.com>
Contributor
Author
|
@tdykstra I addressed the comments. If the build has no warnings and you agree with the applied suggestions, can you please get this merged? |
ahsonkhan
reviewed
Nov 13, 2019
| The return value can be as follows: | ||
| - <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: `source` was successfully and completely decompressed into `destination`. | ||
| - <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType>: There is not enough space in `destination` to decompress `source`. | ||
| - <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress. |
Contributor
There was a problem hiding this comment.
Suggested change
| - <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress. | |
| - <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done. At least one more byte is required to complete the decompression task. This method should be called again with more input to decompress. |
mairaw
removed
the
changes-addressed
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.
As described in the API proposal https://github.com/dotnet/corefx/issues/25785 and the PR that introduced this code dotnet/corefx#26229 .