Skip to content

(AB-568561) Use "[switch] parameter" in conceptual docs#12939

Merged
sdwheeler merged 1 commit intoMicrosoftDocs:mainfrom
michaeltlombardi:ab-568561/main/switch-parameter-conceptual
Apr 8, 2026
Merged

(AB-568561) Use "[switch] parameter" in conceptual docs#12939
sdwheeler merged 1 commit intoMicrosoftDocs:mainfrom
michaeltlombardi:ab-568561/main/switch-parameter-conceptual

Conversation

@michaeltlombardi
Copy link
Copy Markdown
Contributor

PR Summary

This change updates the conceptual content across versions to standardize on referring to parameters of the System.Management.Automation.SwitchParameter type as `[switch]` parameters instead of switch parameters to prevent overlocalization issues.

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 contributor's guide.
  • Style: This PR adheres to the style guide.

Copilot AI review requested due to automatic review settings April 8, 2026 17:52
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread reference/docs-conceptual/learn/deep-dives/everything-about-switch.md Outdated
Comment thread reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-parameters.md Outdated
Comment thread reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-parameters.md Outdated
Comment thread reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-parameters.md Outdated
Comment thread reference/docs-conceptual/developer/cmdlet/background-jobs.md Outdated
Comment thread reference/docs-conceptual/whats-new/differences-from-windows-powershell.md Outdated
Comment thread reference/docs-conceptual/learn/deep-dives/everything-about-shouldprocess.md Outdated
Comment thread reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-parameters.md Outdated
@michaeltlombardi michaeltlombardi force-pushed the ab-568561/main/switch-parameter-conceptual branch from 5384720 to a0f51b3 Compare April 8, 2026 19:42
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The 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 found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit a0f51b3:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/developer/cmdlet/background-jobs.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/cmdlet-dynamic-parameters.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/cmdlet-overview.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/creating-a-cmdlet-to-access-a-data-store.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/how-to-declare-cmdlet-parameters.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/how-to-declare-dynamic-parameters.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/how-to-support-jobs.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/requesting-confirmation-from-cmdlets.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/strongly-encouraged-development-guidelines.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-output.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/cmdlet/types-of-cmdlet-parameters.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/help/how-to-add-dynamic-parameters-to-a-provider-help-topic.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/help/how-to-add-syntax-to-a-cmdlet-help-topic.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/lang-spec/chapter-02.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/lang-spec/chapter-04.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/lang-spec/chapter-06.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/lang-spec/chapter-08.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/learn/deep-dives/everything-about-shouldprocess.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/learn/deep-dives/everything-about-switch.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/learn/Glossary.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/learn/ps101/02-help-system.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/samples/Sorting-Objects.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/whats-new/differences-from-windows-powershell.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/whats-new/What-s-New-in-PowerShell-74.md ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

@sdwheeler sdwheeler merged commit 46dd905 into MicrosoftDocs:main Apr 8, 2026
4 checks passed
@michaeltlombardi michaeltlombardi deleted the ab-568561/main/switch-parameter-conceptual branch April 9, 2026 13:32
Copy link
Copy Markdown

@ayankhan18 ayankhan18 left a comment

Choose a reason for hiding this comment

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

ab 568561

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants