Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[DO NOT MERGE] Testing remarks without endline separation. #5213

Closed
wants to merge 2 commits into from
Closed

[DO NOT MERGE] Testing remarks without endline separation. #5213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb12290
[DO NOT MERGE] Testing remarks without endline separation.
carlossanlop Jan 10, 2021
441c0b8
Remove lines from an exception's '-or-'.
carlossanlop Jan 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions xml/System.IO.Compression/BrotliEncoder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,7 @@
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="quality" /> is not between the minimum value of 0 and the maximum value of 11.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removing the endlines that surround an -or-` causes MS Docs to show everything into one line. The tool needs to preserve empty lines.

https://review.docs.microsoft.com/en-us/dotnet/api/system.io.compression.brotliencoder.-ctor?view=net-5.0&branch=pr-en-us-5213

image

-or-

<paramref name="window" /> is not between the minimum value of 10 and the maximum value of 24.
</exception>
<exception cref="T:System.IO.IOException">Failed to create the <see cref="T:System.IO.Compression.BrotliEncoder" /> instance.</exception>
Expand Down Expand Up @@ -201,11 +199,11 @@
<returns>A number representing the maximum compressed length for the provided input size.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Returns 1 if `inputSize` is 0.

How would it look in the MS Docs Preview.
Copy link
Member Author

Choose a reason for hiding this comment

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

Reconfirmed. Empty lines need to be preserved.
https://review.docs.microsoft.com/en-us/dotnet/api/system.io.compression.brotliencoder.getmaxcompressedlength?view=net-5.0&branch=pr-en-us-5213
image

Copy link
Member Author

Choose a reason for hiding this comment

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

@safern @gewarren when the time comes where we have DLLs generated by the runtime build alongside their fully documented intellisense XMLs, we should test feeding them to mdoc and see if it is smart enough to determine that one single endline should be rendered as a full <br /> in MS Docs.

If I added multiple sentences.
without line separation.
Would it look fine?
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
Expand Down