docs: fix typos #19175

Lioness100 · 2023-02-19T02:56:59Z

PR Summary

This PR fixes some typos throughout the repository. I'm unfamiliar with this codebase, so if I broke anything that needs to be reverted, or if you want me to split this into multiple prs, or anything else please let me know! There were many many "suspected" typos to filter through (52k, although most were duplicates), so I'm sure I've missed or incorrectly handled a few. I have not yet built and tested my changes because I have to leave to do something right now, but I will get to it ASAP.

PR Context

This was a trial run for a CLI I made). I was looking for a very big repository that probably had some typos, and this was a great fit :) thanks alot.

PR Checklist

pull-request-quantifier-deprecated · 2023-02-19T02:57:15Z

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

Quantification details

Label      : Extra Large
Size       : +646 -646
Percentile : 100%

Total files changed: 306

Change summary by file extension:
.psm1 : +54 -54
.cs : +278 -278
.xaml : +1 -1
.resx : +12 -12
.txt : +1 -1
.man : +10 -10
.xsd : +10 -10
.ps1 : +222 -222
.psd1 : +1 -1
.md : +1 -1
.js : +0 -0
.sh : +9 -9
.xml : +1 -1
.yml : +45 -45
.json : +1 -1

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.

Lioness100 · 2023-02-19T15:42:09Z

I don't really understand the error messages with the CI, could someone help me out by telling me what's going wrong? Thanks 😁

Lioness100 · 2023-02-19T15:42:24Z

@microsoft-github-policy-service agree

iSazonov · 2023-02-20T18:05:48Z

@Lioness100 The PR is too large. Please split the PR and group changes in some way (by file types, by folders).

Lioness100 · 2023-02-21T00:07:29Z

Hi @iSazonov! There are a lot of folders in this PR, and I don't want to inconvenience reviewers with a barrage of PRs. Would you allow this PR to go through if I removed any code changes and only kept typo fixes in comments? If not, could you provide a bit more specific guidance into how to split the PRs? Thanks <3333

iSazonov · 2023-02-21T15:54:44Z

@Lioness100 I mean folders in src/ like Microsoft.PowerShell.Commands.Utility.

TravisEz13 · 2023-03-03T21:21:16Z

src/Microsoft.WSMan.Management/WsManHelper.cs

        {
            StringBuilder filter = new StringBuilder();
-            foreach (DictionaryEntry entry in seletorset)
+            foreach (DictionaryEntry entry insselectorset)


This doesn't look right

It would be a lot easier to review if you split this into two PRs. One for comments and one for code. The comments should be easier to review.

TravisEz13 · 2023-03-03T21:22:01Z

src/PowerShell.Core.Instrumentation/PowerShell.Core.Instrumentation.man

@@ -2356,7 +2356,7 @@
              value="8"
              />
          <task
-              message="$(string.PS_PROVIDER.task.T_M3P-ConfiguarationTask.message)"
+              message="$(string.PS_PROVIDER.task.T_M3P-ConfigurationTask.message)"


This is actually in the PowerShell-Native repo

ghost · 2023-03-11T02:00:47Z

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

Lioness100 · 2023-03-11T02:31:59Z

Hi, sorry for the delay, I've been busy. Would you rather Para separated by folders as @iSazonov suggested, or by code vs comments, as @TravisEz13 suggested?

iSazonov · 2023-03-11T06:25:34Z

@Lioness100 No doubt it is better to separate code and comments. If there will still be a lot of changes, please pack the changes into small commits / PRs.

ghost · 2023-03-18T14:00:50Z

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

ghost · 2023-05-30T20:00:51Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

docs: fix typos

333852c

Lioness100 requested review from daxian-dbw, TravisEz13, adityapatwardhan, anmenaga and PaulHigin as code owners February 19, 2023 02:57

ghost assigned iSazonov Feb 19, 2023

pull-request-quantifier-deprecated bot added the Extra Large label Feb 19, 2023

daxian-dbw added the Review - Maintainer The PR/issue needs a review from the PowerShell repo Maintainers label Feb 27, 2023

TravisEz13 reviewed Mar 3, 2023

View reviewed changes

ghost added the Review - Needed The PR is being reviewed label Mar 11, 2023

ghost removed the Review - Needed The PR is being reviewed label Mar 11, 2023

ghost added the Review - Needed The PR is being reviewed label Mar 18, 2023

TravisEz13 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 Review - Maintainer The PR/issue needs a review from the PowerShell repo Maintainers labels May 1, 2023

daxian-dbw added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 1, 2023

StevenBucher98 added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label May 15, 2023

ghost added the Stale label May 30, 2023

ghost closed this Jun 10, 2023

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: fix typos #19175

docs: fix typos #19175

Uh oh!

Lioness100 commented Feb 19, 2023 •

edited

Loading

Uh oh!

pull-request-quantifier-deprecated bot commented Feb 19, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

Lioness100 commented Feb 19, 2023

Uh oh!

Lioness100 commented Feb 19, 2023

Uh oh!

iSazonov commented Feb 20, 2023

Uh oh!

Lioness100 commented Feb 21, 2023

Uh oh!

iSazonov commented Feb 21, 2023

Uh oh!

TravisEz13 Mar 3, 2023

Uh oh!

TravisEz13 Mar 3, 2023

Uh oh!

ghost commented Mar 11, 2023

Uh oh!

Lioness100 commented Mar 11, 2023

Uh oh!

iSazonov commented Mar 11, 2023

Uh oh!

ghost commented Mar 18, 2023

Uh oh!

ghost commented May 30, 2023

Uh oh!

Uh oh!

docs: fix typos #19175

docs: fix typos #19175

Uh oh!

Conversation

Lioness100 commented Feb 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

pull-request-quantifier-deprecated bot commented Feb 19, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

Lioness100 commented Feb 19, 2023

Uh oh!

Lioness100 commented Feb 19, 2023

Uh oh!

iSazonov commented Feb 20, 2023

Uh oh!

Lioness100 commented Feb 21, 2023

Uh oh!

iSazonov commented Feb 21, 2023

Uh oh!

TravisEz13 Mar 3, 2023

Choose a reason for hiding this comment

Uh oh!

TravisEz13 Mar 3, 2023

Choose a reason for hiding this comment

Uh oh!

ghost commented Mar 11, 2023

Uh oh!

Lioness100 commented Mar 11, 2023

Uh oh!

iSazonov commented Mar 11, 2023

Uh oh!

ghost commented Mar 18, 2023

Uh oh!

ghost commented May 30, 2023

Uh oh!

Uh oh!

Lioness100 commented Feb 19, 2023 •

edited

Loading