Skip to content

Update ZipArchive.xml, ZipFile.xml #10193

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

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

edwardneal
Copy link
Contributor

Summary

This PR is an extension of dotnet/runtime#103271, feeding its documentation changes into this repo.

The current documentation for ZipArchive and ZipFile references the entryNameEncoding parameter, describing it as being used to encode/decode ZIP archive entry names. This is incorrect; these two classes actually use this parameter to encode/decode ZIP entry names and comments.

I've also made one change to ZipFile.xml on line 509. This previously said that if entry names and comments contained only ASCII characters, the language encoding flag would be set. This was backwards.

Changed references to entryNameEncoding to clarify that it changes the encoding and decoding of both entry names and comments.
@edwardneal edwardneal requested a review from a team as a code owner August 1, 2024 20:48
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Aug 1, 2024
Copy link
Contributor

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

Copy link

Learn Build status updates of commit f67e849:

✅ Validation status: passed

File Status Preview URL Details
includes/remarks/System.IO.Compression/ZipArchive/.ctor_Stream_ZipArchiveMode_Boolean_Encoding.md ✅Succeeded View
includes/remarks/System.IO.Compression/ZipFile/Open.md ✅Succeeded View
xml/System.IO.Compression/ZipArchive.xml ✅Succeeded View
xml/System.IO.Compression/ZipFile.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

Thanks @edwardneal!

@gewarren gewarren merged commit b2a4028 into dotnet:main Aug 28, 2024
3 checks passed
@edwardneal edwardneal deleted the ziparchiveentry-comment-encodings branch August 29, 2024 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.IO.Compression community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants