-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Fix up all comments to be in the proper order with proper spacing. #18619
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
sdwheeler
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.
This looks good to me. I see that you found many more issues in the tags (typos, missing tags, etc.). This cleanup greatly improves the docs.
|
This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days. |
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.
If the intent of this PR is formatting changes including moving params to the right place, will there be a subsequent PR to fix the params as many are wrong? I do think that should be a separate PR, but because this PR has some param changes, that's not clear of the intent.
src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs
Outdated
Show resolved
Hide resolved
84295da to
e158474
Compare
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.
We discussed this and this will be a 3 stage approach:
- fix syntactical problems with the comment based doc XML (this PR)
- fix the proper elements (follow-up PR)
- fix the content (separate effort)
|
To exclude regressions we need to enable appropriate analyzer rules for doc comments. |
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.
Nested returns above.
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.
fixed
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.
Better swap the lines.
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.
Better swap the lines.
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.
The same - returns is usually last doc 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.
The same.
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.
The same.
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.
The same.
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.
We're going to take a concerted approach to reorder all of the triple-slash comments as a separate approach. I've opened #18744 to track
This will fix issues we have with our autogenerated documentation.
33d6199 to
7817841
Compare
|
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) |
|
This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days. |
|
🎉 Handy links: |
PR Summary
This will fix issues we have with our autogenerated documentation.
PR Context
Some documentation created by automatic generation has issues because:
This PR addresses those issues
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).