Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document System.IO.Compression.Brotli.BrotliDecoder #3379

Merged
merged 2 commits into from Nov 4, 2019
Merged

Conversation

carlossanlop
Copy link
Member

As described in the API proposal https://github.com/dotnet/corefx/issues/25785 and the PR that introduced this code dotnet/corefx#26229 .

@carlossanlop carlossanlop added new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews 🏁 Release: .NET Core 2.x Identifies work items for the .NET Core 2.x releases labels Oct 19, 2019
@carlossanlop carlossanlop added this to the October 2019 milestone Oct 19, 2019
@carlossanlop carlossanlop self-assigned this Oct 19, 2019
@carlossanlop carlossanlop added this to In progress in October 2019 via automation Oct 19, 2019
Copy link
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM aside from a couple of minor suggestions.

xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
Copy link
Member

@ahsonkhan ahsonkhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
xml/System.IO.Compression/BrotliDecoder.xml Show resolved Hide resolved
xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
Copy link
Member Author

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your comments, @ahsonkhan and @tdykstra . I addressed them but have not commited them. Would you mind taking another look?

@carlossanlop carlossanlop added changes-addressed Indicates PRs that had all comments addressed and are awaiting for new review and removed waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews labels Oct 25, 2019
Copy link
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, one additional suggestion.

xml/System.IO.Compression/BrotliDecoder.xml Outdated Show resolved Hide resolved
Co-Authored-By: Tom Dykstra <tdykstra@microsoft.com>
@carlossanlop
Copy link
Member 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?

@tdykstra tdykstra merged commit 71e9068 into master Nov 4, 2019
October 2019 automation moved this from In progress to Done Nov 4, 2019
@tdykstra tdykstra deleted the brotlidecoder branch November 4, 2019 20:19
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 mairaw removed the changes-addressed Indicates PRs that had all comments addressed and are awaiting for new review label Nov 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Release: .NET Core 2.x Identifies work items for the .NET Core 2.x releases new-content Indicates PRs that contain new articles
Projects
No open projects
October 2019
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants