[Docs] Use XML documentation lists - #1948
Merged
Merged
Conversation
Contributor
|
I like it. Looking forward to see more improvements. By the way here is a discussion on this subject, not sure if you reached it yet #1745 |
Contributor
Author
I hadn't read that yet, I hope this PR can be an example of some potential good practices we might want to adopt ❤️ |
Collaborator
|
Doesn't look that great or intuitive to write, so I doubt people will adopt it that easily. Thanks anyway :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Details
Use proper XML documentation list syntax (
<list type="bullet">) (documented here on MSDN for lists across the project.Description
This makes the IDE experience better by properly formatting lists. Also moved some of the lists from
<Summary>to<Remarks>where single-line summaries are preferred.Related Issue
Motivation and Context
This makes the IDE experience better by properly formatting lists.
Types of changes
Checklist