Fix unwieldy XML comment leading to poor IntelliSense#1101
Merged
dluc merged 1 commit intomicrosoft:mainfrom May 19, 2023
Merged
Fix unwieldy XML comment leading to poor IntelliSense#1101dluc merged 1 commit intomicrosoft:mainfrom
dluc merged 1 commit intomicrosoft:mainfrom
Conversation
dluc
approved these changes
May 19, 2023
shawncal
pushed a commit
to shawncal/semantic-kernel
that referenced
this pull request
Jul 6, 2023
### Motivation and Context Clean up an XML comment that was rendering poorly in IntelliSense. ### Description Summaries should be kept short, typically just one sentence. Other details should be put into remarks. And if there's any kind of complicated formatting involved, the appropriate XML tags should be used so that docs and IntelliSense can render it well. Note that there is a separate `<example></example>` tag which I've not used here, as Visual Studio only renders summaries/remarks in IntelliSense today and it seemed like the intent of whoever authored this was to include the example prominently. If that doesn't need to be shown, it'd be better still to separate the example out into such tags.
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
2 participants
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.
Motivation and Context
Clean up an XML comment that was rendering poorly in IntelliSense.
Description
Summaries should be kept short, typically just one sentence. Other details should be put into remarks. And if there's any kind of complicated formatting involved, the appropriate XML tags should be used so that docs and IntelliSense can render it well.
Note that there is a separate
<example></example>tag which I've not used here, as Visual Studio only renders summaries/remarks in IntelliSense today and it seemed like the intent of whoever authored this was to include the example prominently. If that doesn't need to be shown, it'd be better still to separate the example out into such tags.Before
After
Contribution Checklist
dotnet format