-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Fix ///-comments that violate the docs schema #19957
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
michaeltlombardi
left a comment
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.
One note, otherwise LGTM!
src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs
Show resolved
Hide resolved
|
This PR has Quantification details
Why proper sizing of changes matters
Optimal pull request sizes drive a better predictable PR flow as they strike a
What can I do to optimize my changes
How to interpret the change counts in git diff output
Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email) |
SteveL-MSFT
left a comment
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.
LGTM
PR Summary
This PR fixes formatting issues in ///-comments. These comments provide the .NET API documentation for the PowerShell SDK.
PR Context
The docs build system requires that the XML structure of the tags uses in the comments must conform to the schema defined in https://github.com/mono/api-doc-tools/blob/main/mdoc/Resources/monodoc-ecma.xsd.
This PR resolve the following problems from the docs build report:
<remarks>node on Enum fields will be ignored.This PR only changes comments. No code changes.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.(which runs in a different PS Host).