[DO NOT MERGE] Compare brotli and numerics (backported) and http (not backported) #5410
Conversation
| @@ -143,15 +140,7 @@ The return value can be as follows: | |||
| <summary>Attempts to decompress data that was compressed with the Brotli algorithm.</summary> | |||
| <returns> | |||
| <see langword="true" /> on success; <see langword="false" /> otherwise.</returns> | |||
| <remarks> | |||
There was a problem hiding this comment.
I'm curious to see remarks like this: They were fully transformed to xml, but the newlines are probably not going to be respected in the preview. Which means I will have to modify DocsPortingTool so that it wraps every line with <para></para> (if the tool detects at least two paragraphs).
There was a problem hiding this comment.
Yep, we will need to add the <para> tags: https://review.docs.microsoft.com/en-us/dotnet/api/system.io.compression.brotlidecoder.decompress?view=net-5.0&branch=pr-en-us-5410#remarks
There was a problem hiding this comment.
sigh ... This will make our triple slash comments less readable. If that's the only choice we have, then I'll work on fixing the tool to address this.
|
Close/reopen for build. |
|
Yay, no build warnings! |
|
Any idea why ZLibStream didn't show up in the preview? https://github.com/carlossanlop/dotnet-api-docs/blob/testxmls/xml/System.IO.Compression/ZLibStream.xml |
Two reasons:
|
maryamariyan
added
area-System.IO.Compression
area-System.Numerics
area-Meta
This was the original PR, but it was too large to view the diff.
I created this PR with
mainas the baseline, and only cherry-picked files from System.IO.Compression and System.Numerics and System.Net.Http.There are only 2 assemblies that contained intellisense.xml files: Compression.Brotli and Numerics.Vectors.
Everything else from Compression, Numerics, and all of System.Net.Http, was also added to this PR as control, to confirm that the docs remained untouched.