Skip to content

Conversation

@carlossanlop
Copy link
Contributor

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?

@Dotnet-GitSync-Bot
Copy link
Collaborator

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.

@carlossanlop
Copy link
Contributor Author

@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.

@opbld33
Copy link

opbld33 commented Jan 10, 2021

Docs Build status updates of commit fb12290:

✅ Validation status: passed

File Status Preview URL Details
xml/System.IO.Compression/BrotliEncoder.xml ✅Succeeded View

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:

@opbld32
Copy link

opbld32 commented Jan 10, 2021

Docs Build status updates of commit 441c0b8:

✅ Validation status: passed

File Status Preview URL Details
xml/System.IO.Compression/BrotliEncoder.xml ✅Succeeded View

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:

@maryamariyan
Copy link
Contributor

@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.

Copy link
Contributor 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

Returns 1 if `inputSize` is 0.
How would it look in the MS Docs Preview.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor 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.

@carlossanlop carlossanlop deleted the TestLineBreaksRemarks branch August 6, 2024 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants