Skip to content

Conversation

@carlossanlop
Copy link
Contributor

@carlossanlop carlossanlop commented Feb 23, 2021

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:

DocsPortingTool.exe \
-CsProj D:\runtime\src\libraries\System.IO.Compression.ZipFile\src\System.IO.Compression.ZipFile.csproj \
-Docs D:\dotnet-api-docs\xml \
-Direction ToTripleSlash \
-IncludedAssemblies System.IO.Compression \
-IncludedNamespaces System.IO.Compression

Please compare the ported docs with their source files in dotnet-api-docs:

@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code area-System.IO.Compression labels Feb 23, 2021
@carlossanlop carlossanlop added this to the 6.0.0 milestone Feb 23, 2021
@carlossanlop carlossanlop self-assigned this Feb 23, 2021
@carlossanlop carlossanlop marked this pull request as ready for review February 23, 2021 23:44
Copy link
Member

@jeffhandley jeffhandley left a comment

Choose a reason for hiding this comment

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

LGTM when unblocked

Copy link
Member

@adamsitnik adamsitnik left a 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"><![CDATA[
/// [!INCLUDE[remarks](~/includes/remarks/System.IO.Compression/ZipFile/ZipFile.md)]
/// ]]></format></remarks>
public static partial class ZipFile
Copy link
Member

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 { }

@jeffhandley
Copy link
Member

@carlossanlop Is this unblocked now?

@carlossanlop carlossanlop marked this pull request as draft April 19, 2021 22:43
@ghost ghost closed this May 20, 2021
@ghost
Copy link

ghost commented May 20, 2021

Draft Pull Request was automatically closed for inactivity. Please let us know if you'd like to reopen it.

@ghost ghost locked as resolved and limited conversation to collaborators Jun 19, 2021
@carlossanlop carlossanlop deleted the ZipFileBackport branch February 7, 2024 06:42
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.IO.Compression documentation Documentation bug or enhancement, does not impact product or test code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

System.IO.Compression: Backport MS Docs documentation to triple slash

4 participants