Skip to content

Remove outdated DeflateStream 4 GB exception remarks#12712

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/update-deflatestream-remarks
Draft

Remove outdated DeflateStream 4 GB exception remarks#12712
Copilot wants to merge 2 commits into
mainfrom
copilot/update-deflatestream-remarks

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 4, 2026

The DeflateStream docs still stated that compressing files larger than 4 GB throws, which is no longer accurate for current .NET behavior. This update removes that stale limit statement from the affected API docs content so the published guidance matches runtime reality.

  • Scope

    • Updates only DeflateStream remarks content; no API signatures, examples, or metadata changed.
  • Changes

    • Removed the 4 GB exception claim from:
      • includes/remarks/System.IO.Compression/DeflateStream/.ctor_Stream_CompressionMode.md
      • xml/System.IO.Compression/DeflateStream.xml (constructor remarks block)
  • Resulting doc text (excerpt)

If an instance of the <xref:System.IO.Compression.DeflateStream> class is created with the `mode` parameter equal to `Compress`, header information is inserted immediately. If no further action occurs, the stream appears as a valid, empty, compressed file.

By default, the compression level is set to <xref:System.IO.Compression.CompressionLevel.Optimal> when the compression mode is <xref:System.IO.Compression.CompressionMode.Compress>.

Copilot AI changed the title [WIP] Update remarks for DeflateStream to reflect 4 GB limit changes Remove outdated DeflateStream 4 GB exception remarks Jun 4, 2026
Copilot AI requested a review from rzikm June 4, 2026 15:38
Copilot finished work on behalf of rzikm June 4, 2026 15:38
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-io-compression

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The 4 GB limit remarks on DeflateStream seem out of date

2 participants