-
Notifications
You must be signed in to change notification settings - Fork 1.7k
[DO NOT MERGE] Testing remarks without endline separation. #5213
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
|
I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label. |
|
@maryamariyan this is just a testing PR but the bot was unable to apply a label. Do you know if the bot reads the list of files in the PR to decide? I was expecting it to add the IO.Compression label. |
|
Docs Build status updates of commit fb12290: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
Docs Build status updates of commit 441c0b8: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
|
@carlossanlop, if you remember we did not have enough issues labeled so the labeler today only reads the title and description. Only one issue is labeled as area-System.IO.Compression, (list here), and that one is actually an issue not a PR. So there would have been no way for it would have predicted for this one right off the bat. |
| <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. | ||
|
|
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.
Removing the endlines that surround an -or-` causes MS Docs to show everything into one line. The tool needs to preserve empty lines.
| Returns 1 if `inputSize` is 0. | ||
| How would it look in the MS Docs Preview. |
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.
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

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.

Investigation to support this PR: dotnet/runtime#46716
If we backport the comments to triple slash saving lines of code by removing extra empty lines, would the separation would look fine in MS Docs once those comments are sent back to dotnet-api-docs?