Skip to content

Document Invoke-Formatter confirmation parameters - #2232

Merged
Christoph Bergmeister (bergmeister) merged 3 commits into
copilot/add-path-parameter-to-invoke-formatterfrom
copilot/fix-github-actions-job
Oct 22, 2026
Merged

Christoph Bergmeister (bergmeister) merged 3 commits into
copilot/add-path-parameter-to-invoke-formatterfrom
copilot/fix-github-actions-job

Conversation

Copilot AI commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

The CI help test failed because Invoke-Formatter exposes -Confirm and -WhatIf without documenting them.

  • Syntax: List both parameters in each syntax form.
  • Parameter help: Add descriptions and metadata for -Confirm and -WhatIf.

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation-only change covers the exposed parameters, with only minor wording refinements remaining.

2 open issues
What changed in this PR

Updates Invoke-Formatter help to document its existing confirmation parameters and address the reported CI help-test failure.

Changes:

  • Adds -WhatIf and -Confirm to both syntax forms.
  • Adds parameter descriptions and metadata for both switches.
File Description
docs/​Cmdlets/​Invoke-Formatter.md Documents confirmation switches in syntax and parameter help.

Review effort: Balanced

Comment thread docs/Cmdlets/Invoke-Formatter.md Outdated
Comment thread docs/Cmdlets/Invoke-Formatter.md Outdated
Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>
Updated descriptions for -Confirm and -WhatIf parameters to clarify their effects when using the Path and ScriptDefinition options.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The confirmation parameter descriptions need to distinguish suppressing file writes from running formatting and returning output.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

@bergmeister
Christoph Bergmeister (bergmeister) merged commit a69865a into copilot/add-path-parameter-to-invoke-formatter Oct 22, 2026
1 check passed
@bergmeister
Christoph Bergmeister (bergmeister) deleted the copilot/fix-github-actions-job branch October 22, 2026 23:57
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.

3 participants