Skip to content
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

Fix issues in *-Object documentation #10647

Merged

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Nov 16, 2023

PR Summary

Prior to this change:

  • The UseNewRunspace parameter of the ForEach-Object cmdlet wasn't included in the cmdlet syntax for any parameter set.
  • The "Notes" section of ForEach-Object directed users to the wrong example for thread safety.
  • The Where-Object reference documentation used the where alias throughout the article, not just when discussing the alias specifically.
  • The SkipIndex parameter of the Select-Object cmdlet was missing a description entirely and didn't indicate the version of PowerShell it was added in.

This change:

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

Copy link
Contributor

Learn Build status updates of commit 720050a:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/ForEach-Object.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Utility/Select-Object.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/ForEach-Object.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Utility/Select-Object.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/ForEach-Object.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Utility/Select-Object.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

Prior to this change:

- The **UseNewRunspace** parameter of the `ForEach-Object` cmdlet
  wasn't included in the cmdlet syntax for any parameter set.
- The "Notes" section of `ForEach-Object` directed users to the wrong
  example for thread safety.
- The `Where-Object` reference documentation used the `where` alias
  throughout the article, not just when discussing the alias
  specifically.
- The **SkipIndex** parameter of the `Select-Object` cmdlet was missing
  a description entirely and didn't indicate the version of PowerShell
  it was added in.

This change:

- Adds the **UseNewRunspace** parameter to the `ParallelParameterSet`
  syntax of the `ForEach-Object` cmdlet reference.

  - Fixes MicrosoftDocs#10642
  - Fixes AB#183543
- Ensures that the notes section of `ForEach-Object` points to the
  correct example.

  - Fixes MicrosoftDocs#10643
  - Fixes AB#183544
- Replaces all instances of `where` with `Where-Object` in the
  `Where-Object` reference documentation except where discussing the
  `where` alias specifically.

  - Fixes MicrosoftDocs#10644
  - Fixes AB#183545
- Documents the **SkipIndex** parameter of the `Select-Object` cmdlet
  and indicates that it was added in PowerShell 6.0.

  - Fixes MicrosoftDocs#10645
  - Fixes AB#183546
@sdwheeler sdwheeler force-pushed the fix/main/foreach-where-select branch from 720050a to f4901c8 Compare November 16, 2023 20:16
Copy link
Contributor

Learn Build status updates of commit f4901c8:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/ForEach-Object.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Utility/Select-Object.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/ForEach-Object.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Utility/Select-Object.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/ForEach-Object.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/Where-Object.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Utility/Select-Object.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit 104c9f1 into MicrosoftDocs:main Nov 16, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants