-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Backport System.IO.Compression.ZipFile docs #48633
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
Conversation
jeffhandley
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM when unblocked
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Create.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Create.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.IO.Compression.ZipFile/src/System/IO/Compression/ZipFile.Extract.cs
Outdated
Show resolved
Hide resolved
...stem.IO.Compression.ZipFile/src/System/IO/Compression/ZipFileExtensions.ZipArchive.Create.cs
Outdated
Show resolved
Hide resolved
adamsitnik
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you @carlossanlop
| /// <remarks><format type="text/markdown"><] | ||
| /// ]]></format></remarks> | ||
| public static partial class ZipFile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we have a separate copy of the xml docs for every .cs file that belongs to the same partial class? What if someone edits just one of them?
/// <summary>true</summary>
public partial class Sample { }
/// <summary>false</summary>
public partial class Sample { }|
@carlossanlop Is this unblocked now? |
|
Draft Pull Request was automatically closed for inactivity. Please let us know if you'd like to reopen it. |
Blocked by dotnet/dotnet-api-docs#5363 which moves lengthy remarks to their own md files so they don't get backported.
Backporting public API documentation from MS Docs into triple slash comments for the System.IO.Compression.ZipFile assembly.
The full description of the purpose of this PR is described in the issue #44969 - Pilot a new process that extracts API documentation from source code under the section "Bring documentation from Docs to triple slash".
I ran the porting tool using this command:
Please compare the ported docs with their source files in dotnet-api-docs: