Skip to content

Remove outdated DeflateStream 4 GB exception remarks#12712

Open
Copilot wants to merge 3 commits into
mainfrom
copilot/update-deflatestream-remarks
Open

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

Conversation

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

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
@rzikm rzikm marked this pull request as ready for review June 8, 2026 09:52
@rzikm rzikm requested a review from a team as a code owner June 8, 2026 09:52
@rzikm rzikm requested review from a team and Copilot June 8, 2026 09:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This pull request updates the .NET API reference documentation for System.IO.Compression.DeflateStream to remove an outdated claim that compressing files larger than 4 GB causes an exception, aligning the docs with current runtime behavior.

Changes:

  • Removed the 4 GB exception statement from the constructor remarks include file.
  • Removed the same outdated statement from the DeflateStream XML constructor remarks block.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
xml/System.IO.Compression/DeflateStream.xml Removes the outdated 4 GB exception remark from the constructor group documentation.
includes/remarks/System.IO.Compression/DeflateStream/.ctor_Stream_CompressionMode.md Removes the outdated 4 GB exception remark from the shared constructor remarks content.

Comment thread xml/System.IO.Compression/DeflateStream.xml
Copilot AI requested a review from MihaZupan June 8, 2026 12:09
@rzikm rzikm enabled auto-merge (squash) June 8, 2026 12:36
@gewarren

gewarren commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

There is a problem with the docs build system right now; I'll update when it's fixed.

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

6 participants