Skip to content

Update the constant WhatIf description #780

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

Merged
merged 2 commits into from
Jul 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Model/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ internal static partial class Constants
internal const string LocaleEnUs = "en-US";
internal const string skippingMessageFmt = "'{0}' exists, skipping. Use -Force to overwrite.";
internal const string ConfirmParameterDescription = "Prompts you for confirmation before running the cmdlet.";
internal const string WhatIfParameterDescription = "Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes.";
internal const string WhatIfParameterDescription = "Runs the command in a mode that only reports what would happen without performing the actions.";

// TODO: ProgressAction is not a common parameter for all versions of PowerShell.
// This should not be added under all circumstances.
Expand Down
2 changes: 1 addition & 1 deletion test/Pester/NewMarkdownHelp.Tests.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ Write-Host 'Hello World!'

It 'should have a description for Confirm and WhatIf parameters' {
$file | Should -FileContentMatch 'Prompts you for confirmation before running the cmdlet.'
$file | Should -FileContentMatch 'Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes.'
$file | Should -FileContentMatch 'Runs the command in a mode that only reports what would happen without performing the actions.'
}
}
}