(AB-568561) Use "[switch] parameter" in conceptual docs#12939
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Pull request overview
This PR standardizes conceptual documentation to refer to System.Management.Automation.SwitchParameter-typed parameters as `[switch]` parameters (instead of “switch parameters”) to reduce localization/overlocalization issues.
Changes:
- Replaces “switch parameter(s)” with
`[switch]` parameter(s)across multiple conceptual and developer docs. - Updates related headings and reflows some paragraphs to accommodate the new inline-code term.
- Applies the terminology update across “What’s New”, learn content, language spec chapters, and cmdlet developer guidance.
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/docs-conceptual/whats-new/What-s-New-in-PowerShell-74.md | Updates a release note to use `[switch]` parameter terminology. |
| reference/docs-conceptual/whats-new/differences-from-windows-powershell.md | Rewords SwitchParameter references to use `[switch]` formatting. |
| reference/docs-conceptual/samples/Sorting-Objects.md | Updates sample narrative to use `[switch]` parameter wording. |
| reference/docs-conceptual/learn/ps101/02-help-system.md | Renames section and body text to `[switch]` parameters. |
| reference/docs-conceptual/learn/Glossary.md | Updates glossary term and definition to use `[switch]` formatting. |
| reference/docs-conceptual/learn/deep-dives/everything-about-switch.md | Updates discussion of switch statement parameters to use `[switch]` term. |
| reference/docs-conceptual/learn/deep-dives/everything-about-shouldprocess.md | Updates section/paragraphs discussing switch parameters to `[switch]`. |
| reference/docs-conceptual/lang-spec/chapter-08.md | Updates language spec phrasing to “`[switch]` parameter”. |
| reference/docs-conceptual/lang-spec/chapter-06.md | Updates conversion rule phrasing to “`[switch]` parameter”. |
| reference/docs-conceptual/lang-spec/chapter-04.md | Updates table description text to refer to “`[switch]` parameter”. |
| reference/docs-conceptual/lang-spec/chapter-02.md | Updates argument kind name to “`[switch]` parameter”. |
| reference/docs-conceptual/developer/help/how-to-add-syntax-to-a-cmdlet-help-topic.md | Updates help-authoring guidance to use `[switch]` parameters. |
| reference/docs-conceptual/developer/help/how-to-add-dynamic-parameters-to-a-provider-help-topic.md | Updates provider help-authoring guidance to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-parameters.md | Updates cmdlet parameter-type guidance to use `[switch]` wording. |
| reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-output.md | Updates PassThru guidance to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/strongly-encouraged-development-guidelines.md | Updates “true/false parameter” guidance to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/requesting-confirmation-from-cmdlets.md | Updates Force parameter guidance to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/how-to-support-jobs.md | Updates AsJob guidance to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/how-to-declare-dynamic-parameters.md | Updates dynamic parameter example narrative to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/how-to-declare-cmdlet-parameters.md | Updates “declare parameters” overview + heading to `[switch]` wording. |
| reference/docs-conceptual/developer/cmdlet/creating-a-cmdlet-to-access-a-data-store.md | Updates cmdlet walkthrough text to use `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/cmdlet-overview.md | Updates cmdlet overview terminology to `[switch]` parameters. |
| reference/docs-conceptual/developer/cmdlet/cmdlet-dynamic-parameters.md | Updates dynamic parameter overview line to `[switch]` parameter. |
| reference/docs-conceptual/developer/cmdlet/background-jobs.md | Updates job-support checklist bullet to `[switch]` parameter. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
5384720 to
a0f51b3
Compare
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 |
PR Summary
This change updates the conceptual 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