Skip to content

Commit 39c1eae

Browse files
authored
Fix typos in PSSA docs (#106)
1 parent 920a993 commit 39c1eae

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingWMICmdlet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ Change to the equivalent CIM based cmdlet.
4848

4949
```powershell
5050
Get-WmiObject -Query 'Select * from Win32_Process where name LIKE "myprocess%"' | Remove-WmiObject
51-
Invoke-WmiMethod ?Class Win32_Process ?Name "Create" ?ArgumentList @{ CommandLine = "notepad.exe" }
51+
Invoke-WmiMethod -Class Win32_Process -Name "Create" -ArgumentList @{ CommandLine = "notepad.exe" }
5252
```
5353

5454
### Correct
5555

5656
```powershell
5757
Get-CimInstance -Query 'Select * from Win32_Process where name LIKE "myprocess%"' | Remove-CIMInstance
58-
Invoke-CimMethod ?ClassName Win32_Process ?MethodName "Create" ?Arguments @{ CommandLine = "notepad.exe" }
58+
Invoke-CimMethod -ClassName Win32_Process -MethodName "Create" -Arguments @{ CommandLine = "notepad.exe" }
5959
```

reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The PSScriptAnalyzer contains the following rule definitions.
5757
| [ReservedCmdletChar](./ReservedCmdletChar.md) | Error | Yes | |
5858
| [ReservedParams](./ReservedParams.md) | Error | Yes | |
5959
| [ReviewUnusedParameter](./ReviewUnusedParameter.md) | Warning | Yes | |
60-
| [ShouldProcess](./ShouldProcess.md) | Error | Yes | |
60+
| [ShouldProcess](./ShouldProcess.md) | Warning | Yes | |
6161
| [UseApprovedVerbs](./UseApprovedVerbs.md) | Warning | Yes | |
6262
| [UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning | Yes | |
6363
| [UseCmdletCorrectly](./UseCmdletCorrectly.md) | Warning | Yes | |

reference/docs-conceptual/PSScriptAnalyzer/Rules/ShouldProcess.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: ShouldProcess
1414
If a cmdlet declares the `SupportsShouldProcess` attribute, then it should also call
1515
`ShouldProcess`. A violation is any function which either declares `SupportsShouldProcess` attribute
1616
but makes no calls to `ShouldProcess` or it calls `ShouldProcess` but does not declare
17-
`SupportsShouldProcess`
17+
`SupportsShouldProcess`.
1818

1919
For more information, see the following articles:
2020

@@ -26,7 +26,7 @@ For more information, see the following articles:
2626

2727
To fix a violation of this rule, please call `ShouldProcess` method when a cmdlet declares
2828
`SupportsShouldProcess` attribute. Or please add `SupportsShouldProcess` attribute argument when
29-
calling `ShouldProcess`
29+
calling `ShouldProcess`.
3030

3131
## Example
3232

0 commit comments

Comments
 (0)