X Tutup
Skip to content

Fix up all comments to be in the proper order with proper spacing.#18619

Merged
daxian-dbw merged 2 commits intoPowerShell:masterfrom
JamesWTruher:SummaryDocFix01
Jan 3, 2023
Merged

Fix up all comments to be in the proper order with proper spacing.#18619
daxian-dbw merged 2 commits intoPowerShell:masterfrom
JamesWTruher:SummaryDocFix01

Conversation

@JamesWTruher
Copy link
Copy Markdown
Collaborator

@JamesWTruher JamesWTruher commented Nov 19, 2022

PR Summary

This will fix issues we have with our autogenerated documentation.

PR Context

Some documentation created by automatic generation has issues because:

  • some of tags are not in the appropriate location
  • some tags have spelling errors
  • some tags do not have consistent spacing

This PR addresses those issues

PR Checklist

@ghost ghost assigned anmenaga Nov 19, 2022
@JamesWTruher JamesWTruher requested review from sdwheeler and removed request for PaulHigin, anmenaga and daxian-dbw November 19, 2022 19:14
sdwheeler
sdwheeler approved these changes Nov 22, 2022
View reviewed changes
Copy link
Copy Markdown
Collaborator

@sdwheeler sdwheeler left a 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.

@ghost ghost added the Review - Needed The PR is being reviewed label Nov 30, 2022
@ghost
Copy link
Copy Markdown

ghost commented Nov 30, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@JamesWTruher JamesWTruher changed the title WIP: Fix up all comments to be in the proper order with proper spacing. Fix up all comments to be in the proper order with proper spacing. Nov 30, 2022
SteveL-MSFT
SteveL-MSFT requested changes Nov 30, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@SteveL-MSFT SteveL-MSFT left a 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.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels Nov 30, 2022
SteveL-MSFT
SteveL-MSFT approved these changes Nov 30, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@SteveL-MSFT SteveL-MSFT left a 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)

@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Dec 1, 2022

To exclude regressions we need to enable appropriate analyzer rules for doc comments.

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistryKey.cs Outdated
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

Choose a reason for hiding this comment

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

Nested returns above.

Copy link
Copy Markdown
Collaborator Author

@JamesWTruher JamesWTruher Dec 7, 2022

Choose a reason for hiding this comment

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

fixed

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistryKey.cs Outdated
Comment on lines 901 to 902
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

Choose a reason for hiding this comment

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

Better swap the lines.

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistryKey.cs Outdated
Comment on lines 1111 to 1112
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

Choose a reason for hiding this comment

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

Better swap the lines.

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistryKey.cs Outdated
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

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.

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistryKey.cs Outdated
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

Choose a reason for hiding this comment

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

The same.

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistryKey.cs Outdated
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

Choose a reason for hiding this comment

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

The same.

iSazonov
iSazonov reviewed Dec 1, 2022
View reviewed changes
src/System.Management.Automation/namespaces/TransactedRegistrySecurity.cs Outdated
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 1, 2022

Choose a reason for hiding this comment

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

The same.

Copy link
Copy Markdown
Collaborator Author

@JamesWTruher JamesWTruher Dec 7, 2022

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

@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 7, 2022
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

pull-request-quantifier-deprecated bot commented Dec 8, 2022

This PR has 0 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : No Changes
Size       : +0 -0
Percentile : 0%

Total files changed: 52

Change summary by file extension:
.cs : +0 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@ghost ghost added the Review - Needed The PR is being reviewed label Dec 16, 2022
@ghost
Copy link
Copy Markdown

ghost commented Dec 16, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@daxian-dbw daxian-dbw merged commit 4f57804 into PowerShell:master Jan 3, 2023
@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 3, 2023
@adityapatwardhan adityapatwardhan added the CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log label Mar 14, 2023
@ghost
Copy link
Copy Markdown

ghost commented Mar 14, 2023

🎉v7.4.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov left review comments

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

@adityapatwardhan adityapatwardhan Awaiting requested review from adityapatwardhan adityapatwardhan is a code owner

@TravisEz13 TravisEz13 Awaiting requested review from TravisEz13 TravisEz13 is a code owner

+1 more reviewer

@sdwheeler sdwheeler sdwheeler approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@anmenaga anmenaga

Labels

CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log No Changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@JamesWTruher @iSazonov @SteveL-MSFT @sdwheeler @daxian-dbw @anmenaga @adityapatwardhan
X Tutup