Skip to content

Commit d749310

Browse files
nschonnisdwheeler
authored andcommitted
typo: Whatif -> WhatIf (#3961)
1 parent 8fc7bbc commit d749310

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

developer/cmdlet/required-development-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ To make these calls the cmdlet must specify that it supports confirmation reques
116116
> [!NOTE]
117117
> If the Cmdlet attribute of the cmdlet class indicates that the cmdlet supports calls to the [System.Management.Automation.Cmdlet.ShouldProcess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method, and the cmdlet fails to make the call to the [System.Management.Automation.Cmdlet.ShouldProcess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method, the user could modify the system unexpectedly.
118118
119-
Use the [System.Management.Automation.Cmdlet.ShouldProcess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method for any system modification. A user preference and the `Whatif` parameter control the [System.Management.Automation.Cmdlet.ShouldProcess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method. In contrast, the [System.Management.Automation.Cmdlet.ShouldContinue*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldContinue) call performs an additional check for potentially dangerous modifications. This method is not controlled by any user preference or the `Whatif` parameter. If your cmdlet calls the [System.Management.Automation.Cmdlet.ShouldContinue*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldContinue) method, it should have a `Force` parameter that bypasses the calls to these two methods and that proceeds with the operation. This is important because it allows your cmdlet to be used in non-interactive scripts and hosts.
119+
Use the [System.Management.Automation.Cmdlet.ShouldProcess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method for any system modification. A user preference and the `WhatIf` parameter control the [System.Management.Automation.Cmdlet.ShouldProcess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method. In contrast, the [System.Management.Automation.Cmdlet.ShouldContinue*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldContinue) call performs an additional check for potentially dangerous modifications. This method is not controlled by any user preference or the `WhatIf` parameter. If your cmdlet calls the [System.Management.Automation.Cmdlet.ShouldContinue*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldContinue) method, it should have a `Force` parameter that bypasses the calls to these two methods and that proceeds with the operation. This is important because it allows your cmdlet to be used in non-interactive scripts and hosts.
120120

121121
If your cmdlets support these calls, the user can determine whether the action should actually be performed. For example, the [Stop-Process](/powershell/module/microsoft.powershell.management/stop-process) cmdlet calls the [System.Management.Automation.Cmdlet.ShouldContinue*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldContinue) method before it stops a set of critical processes, including the System, Winlogon, and Spoolsrv processes.
122122

gallery/how-to/publishing-packages/publishing-a-package.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,16 +131,16 @@ RequiredVersion.
131131
Most of the other options in the command line should be in the manifest data for the item you are
132132
publishing, so you should not need to specify them in the command.
133133

134-
To avoid errors, it is strongly recommended that you try the commands using -Whatif -Verbose,
134+
To avoid errors, it is strongly recommended that you try the commands using -WhatIf -Verbose,
135135
before publishing. This will save considerable time, since every time you publish to the PowerShell
136136
Gallery, you must update the version number in the manifest section of the item.
137137

138138
Examples would be:
139139

140-
* `Publish-Module -Path ".\MyModule" -NugetAPIKey "GUID" -Whatif -Verbose`
141-
* `Publish-Script -Path ".\MyScriptFile.PS1" -NugetAPIKey "GUID" -Whatif -Verbose`
140+
* `Publish-Module -Path ".\MyModule" -NugetAPIKey "GUID" -WhatIf -Verbose`
141+
* `Publish-Script -Path ".\MyScriptFile.PS1" -NugetAPIKey "GUID" -WhatIf -Verbose`
142142

143-
Review the output carefully, and if you see no errors or warnings, repeat the command without -Whatif.
143+
Review the output carefully, and if you see no errors or warnings, repeat the command without -WhatIf.
144144

145145
All items that are published to the PowerShell Gallery will be scanned for viruses, and will be
146146
analyzed using the PowerShell Script Analyzer. Any issues that arise at that time will be sent back

reference/3.0/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ The **Force** parameter gets hidden files, which would otherwise be excluded.
100100

101101
The pipeline operator (|) sends the objects representing the retrieved files to the `Set-Acl` cmdlet, which applies the security descriptor in the **AclObject** parameter to all of the files in the pipeline.
102102

103-
In practice, it is best to use the **Whatif** parameter with all `Set-Acl` commands that can affect more than one item.
103+
In practice, it is best to use the **WhatIf** parameter with all `Set-Acl` commands that can affect more than one item.
104104
In this case, the second command in the pipeline would be "`Set-Acl -AclObject $NewAcl -WhatIf`".
105105
This command lists the files that would be affected by the command.
106-
After reviewing the result, you can run the command again without the **Whatif** parameter.
106+
After reviewing the result, you can run the command again without the **WhatIf** parameter.
107107

108108
## PARAMETERS
109109

reference/4.0/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ The **Force** parameter gets hidden files, which would otherwise be excluded.
9393

9494
The pipeline operator (|) sends the objects representing the retrieved files to the `Set-Acl` cmdlet, which applies the security descriptor in the **AclObject** parameter to all of the files in the pipeline.
9595

96-
In practice, it is best to use the **Whatif** parameter with all `Set-Acl` commands that can affect more than one item.
96+
In practice, it is best to use the **WhatIf** parameter with all `Set-Acl` commands that can affect more than one item.
9797
In this case, the second command in the pipeline would be "`Set-Acl -AclObject $NewAcl -WhatIf`".
9898
This command lists the files that would be affected by the command.
99-
After reviewing the result, you can run the command again without the **Whatif** parameter.
99+
After reviewing the result, you can run the command again without the **WhatIf** parameter.
100100

101101
## PARAMETERS
102102

reference/5.0/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ The **Force** parameter gets hidden files, which would otherwise be excluded.
9999

100100
The pipeline operator (|) sends the objects representing the retrieved files to the `Set-Acl` cmdlet, which applies the security descriptor in the **AclObject** parameter to all of the files in the pipeline.
101101

102-
In practice, it is best to use the **Whatif** parameter with all `Set-Acl` commands that can affect more than one item.
102+
In practice, it is best to use the **WhatIf** parameter with all `Set-Acl` commands that can affect more than one item.
103103
In this case, the second command in the pipeline would be "`Set-Acl -AclObject $NewAcl -WhatIf`".
104104
This command lists the files that would be affected by the command.
105-
After reviewing the result, you can run the command again without the **Whatif** parameter.
105+
After reviewing the result, you can run the command again without the **WhatIf** parameter.
106106

107107
## PARAMETERS
108108

reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,10 @@ The **Force** parameter gets hidden files, which would otherwise be excluded.
9494

9595
The pipeline operator (|) sends the objects representing the retrieved files to the `Set-Acl` cmdlet, which applies the security descriptor in the **AclObject** parameter to all of the files in the pipeline.
9696

97-
In practice, it is best to use the **Whatif** parameter with all `Set-Acl` commands that can affect more than one item.
97+
In practice, it is best to use the **WhatIf** parameter with all `Set-Acl` commands that can affect more than one item.
9898
In this case, the second command in the pipeline would be "`Set-Acl -AclObject $NewAcl -WhatIf`".
9999
This command lists the files that would be affected by the command.
100-
After reviewing the result, you can run the command again without the **Whatif** parameter.
100+
After reviewing the result, you can run the command again without the **WhatIf** parameter.
101101

102102
## PARAMETERS
103103

reference/6/Microsoft.PowerShell.Security/Set-Acl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ The **Force** parameter gets hidden files, which would otherwise be excluded.
9898

9999
The pipeline operator (|) sends the objects representing the retrieved files to the `Set-Acl` cmdlet, which applies the security descriptor in the **AclObject** parameter to all of the files in the pipeline.
100100

101-
In practice, it is best to use the **Whatif** parameter with all `Set-Acl` commands that can affect more than one item.
101+
In practice, it is best to use the **WhatIf** parameter with all `Set-Acl` commands that can affect more than one item.
102102
In this case, the second command in the pipeline would be "`Set-Acl -AclObject $NewAcl -WhatIf`".
103103
This command lists the files that would be affected by the command.
104-
After reviewing the result, you can run the command again without the **Whatif** parameter.
104+
After reviewing the result, you can run the command again without the **WhatIf** parameter.
105105

106106
## PARAMETERS
107107

0 commit comments

Comments
 (0)