(AB-568561) Use "[switch] parameter" in reference content#12937
Merged
sdwheeler merged 6 commits intoMicrosoftDocs:mainfrom Apr 8, 2026
Merged
Conversation
This comment was marked as off-topic.
This comment was marked as off-topic.
sdwheeler
force-pushed
the
ab-568561/main/switch-parameter-reference
branch
from
0dfbd2e to
4bd4fb3
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Contributor
There was a problem hiding this comment.
Pull request overview
Standardizes PowerShell reference documentation to refer to System.Management.Automation.SwitchParameter-typed parameters as `[switch]` parameters (instead of “switch parameters”) to reduce overlocalization issues across multiple doc versions.
Changes:
- Replaced “switch parameter(s)” phrasing with
`[switch]` parameter(s)in reference and about_* content (PowerShell 7.6/7.5/7.4/5.1). - Updated related headings/sentences and reflowed paragraphs to accommodate the new inline-code terminology.
- Removed an unprofessional HTML comment in
about_Command_Syntax.
Reviewed changes
Copilot reviewed 52 out of 52 changed files in this pull request and generated 17 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/7.6/Microsoft.PowerShell.Utility/Show-Command.md | Terminology update to `[switch]` parameter in description text. |
| reference/7.6/Microsoft.PowerShell.Utility/ConvertTo-Json.md | Terminology update to `[switch]` parameter in example narration. |
| reference/7.6/Microsoft.PowerShell.Management/Resolve-Path.md | Terminology update to `[switch]` parameter in examples/parameter description. |
| reference/7.6/Microsoft.PowerShell.Core/Where-Object.md | Terminology update to `[switch]` parameters in simplified syntax description. |
| reference/7.6/Microsoft.PowerShell.Core/Get-Help.md | Terminology update to `[switch]` parameter in parameter description. |
| reference/7.6/Microsoft.PowerShell.Core/Disable-PSRemoting.md | Terminology update to `[switch]` parameter in loopback connection notes. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_Splatting.md | Terminology update to `[switch]` parameters in splatting guidance. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_Requires.md | Terminology update to `[switch]` parameter for #Requires switch. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_Pwsh.md | Terminology update to `[switch]` parameters in -File section. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_PowerShell_Editions.md | Terminology update to `[switch]` parameter for -SkipEditionCheck. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_Parameters_Default_Values.md | Terminology update to `[switch]` parameters in defaults guidance. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_Functions.md | Terminology update (including heading) to `[switch]` parameters. |
| reference/7.6/Microsoft.PowerShell.Core/About/about_Command_Syntax.md | Terminology update to `[switch]` parameters; removed unprofessional comment. |
| reference/7.6/CimCmdlets/New-CimSession.md | Terminology update to `[switch]` parameter for -SkipTestConnection. |
| reference/7.5/Microsoft.PowerShell.Utility/Show-Command.md | Terminology update to `[switch]` parameter in description text. |
| reference/7.5/Microsoft.PowerShell.Utility/ConvertTo-Json.md | Terminology update to `[switch]` parameter in example narration. |
| reference/7.5/Microsoft.PowerShell.Management/Resolve-Path.md | Terminology update to `[switch]` parameter in examples/parameter description. |
| reference/7.5/Microsoft.PowerShell.Core/Where-Object.md | Terminology update to `[switch]` parameters in simplified syntax description. |
| reference/7.5/Microsoft.PowerShell.Core/Get-Help.md | Terminology update to `[switch]` parameter in parameter description. |
| reference/7.5/Microsoft.PowerShell.Core/Disable-PSRemoting.md | Terminology update to `[switch]` parameter in loopback connection notes. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_Splatting.md | Terminology update to `[switch]` parameters in splatting guidance. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_Requires.md | Terminology update to `[switch]` parameter for #Requires switch. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_Pwsh.md | Terminology update to `[switch]` parameters in -File section; also edits -CommandWithArgs status text. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_PowerShell_Editions.md | Terminology update to `[switch]` parameter for -SkipEditionCheck. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_Parameters_Default_Values.md | Terminology update to `[switch]` parameters in defaults guidance. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_Functions.md | Terminology update (including heading) to `[switch]` parameters. |
| reference/7.5/Microsoft.PowerShell.Core/About/about_Command_Syntax.md | Terminology update to `[switch]` parameters; removed unprofessional comment. |
| reference/7.5/CimCmdlets/New-CimSession.md | Terminology update to `[switch]` parameter for -SkipTestConnection. |
| reference/7.4/Microsoft.PowerShell.Utility/Show-Command.md | Terminology update to `[switch]` parameter in description text. |
| reference/7.4/Microsoft.PowerShell.Utility/ConvertTo-Json.md | Terminology update to `[switch]` parameter in example narration. |
| reference/7.4/Microsoft.PowerShell.Management/Resolve-Path.md | Terminology update to `[switch]` parameter in examples/parameter description. |
| reference/7.4/Microsoft.PowerShell.Core/Where-Object.md | Terminology update to `[switch]` parameters in simplified syntax description. |
| reference/7.4/Microsoft.PowerShell.Core/Get-Help.md | Terminology update to `[switch]` parameter in parameter description. |
| reference/7.4/Microsoft.PowerShell.Core/Disable-PSRemoting.md | Terminology update to `[switch]` parameter in loopback connection notes. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_Splatting.md | Terminology update to `[switch]` parameters in splatting guidance. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_Requires.md | Terminology update to `[switch]` parameter for #Requires switch. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_Pwsh.md | Terminology update to `[switch]` parameters in -File section. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_PowerShell_Editions.md | Terminology update to `[switch]` parameter for -SkipEditionCheck. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_Parameters_Default_Values.md | Terminology update to `[switch]` parameters in defaults guidance. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_Functions.md | Terminology update (including heading) to `[switch]` parameters. |
| reference/7.4/Microsoft.PowerShell.Core/About/about_Command_Syntax.md | Terminology update to `[switch]` parameters; removed unprofessional comment. |
| reference/7.4/CimCmdlets/New-CimSession.md | Terminology update to `[switch]` parameter for -SkipTestConnection. |
| reference/5.1/Microsoft.PowerShell.Utility/Show-Command.md | Terminology update to `[switch]` parameter in description text. |
| reference/5.1/Microsoft.PowerShell.Core/Where-Object.md | Terminology update to `[switch]` parameters in simplified syntax description. |
| reference/5.1/Microsoft.PowerShell.Core/Get-Help.md | Terminology update to `[switch]` parameter in parameter description. |
| reference/5.1/Microsoft.PowerShell.Core/Disable-PSRemoting.md | Terminology update to `[switch]` parameter in loopback connection notes. |
| reference/5.1/Microsoft.PowerShell.Core/About/about_Splatting.md | Terminology update to `[switch]` parameters in splatting guidance. |
| reference/5.1/Microsoft.PowerShell.Core/About/about_Requires.md | Terminology update to `[switch]` parameter for #Requires switch. |
| reference/5.1/Microsoft.PowerShell.Core/About/about_Parameters_Default_Values.md | Terminology update to `[switch]` parameters in defaults guidance. |
| reference/5.1/Microsoft.PowerShell.Core/About/about_Functions.md | Terminology update (including heading) to `[switch]` parameters. |
| reference/5.1/Microsoft.PowerShell.Core/About/about_Command_Syntax.md | Terminology update to `[switch]` parameters; removed unprofessional comment. |
| reference/5.1/CimCmdlets/New-CimSession.md | Terminology update to `[switch]` parameter for -SkipTestConnection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
michaeltlombardi
force-pushed
the
ab-568561/main/switch-parameter-reference
branch
from
4fed816 to
3fcb6b9
Compare
Contributor
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Contributor
michaeltlombardi
changed the title
[switch] parameter ` in reference content[switch] parameter" in reference content
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
This change updates the reference content across versions to standardize on referring to parameters of the
System.Management.Automation.SwitchParametertype as`[switch]` parametersinstead ofswitch parametersto prevent overlocalization issues.PR Checklist