Fix DeflateStream.Flush() summary: method is not a no-op when compressing#12756
Open
Copilot wants to merge 2 commits into
Open
Fix DeflateStream.Flush() summary: method is not a no-op when compressing#12756Copilot wants to merge 2 commits into
Copilot wants to merge 2 commits into
Conversation
Copilot
AI
changed the title
[WIP] Fix documentation for DeflateStream.Flush implementation in .NET 10
Fix DeflateStream.Flush() summary: method is not a no-op when compressing
Jun 17, 2026
gewarren
approved these changes
Jun 17, 2026
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-io-compression |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the API reference documentation for System.IO.Compression.DeflateStream.Flush() so it no longer contradicts the .NET 10+ implementation behavior.
Changes:
- Replaces the
Flush()<summary>text that previously claimed the method had no functionality. - Updates the
Flush()<remarks>to distinguish behavior betweenCompressionMode.Compress(flushes) andCompressionMode.Decompress(no-op).
| <Parameters /> | ||
| <Docs> | ||
| <summary>The current implementation of this method has no functionality.</summary> | ||
| <summary>Flushes the internal buffer to the underlying stream.</summary> |
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
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.
The
Flush()summary incorrectly stated "The current implementation of this method has no functionality." — directly contradicting the .NET 10 implementation, which callsFlushBuffers()when inCompressionMode.Compress.Changes
xml/System.IO.Compression/DeflateStream.xml<summary>to: "Flushes the internal buffer to the underlying stream."<remarks>to explicitly distinguish behavior by mode: flushes when compressing, no-op when decompressing.