Skip to content

Commit a754b95

Browse files
authored
1 parent a0365a5 commit a754b95

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/Rules/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: List of PSScriptAnalyzer rules
33
ms.custom: PSSA v1.22.0
4-
ms.date: 02/13/2024
4+
ms.date: 03/27/2024
55
ms.topic: reference
66
title: List of PSScriptAnalyzer rules
77
---
@@ -58,7 +58,7 @@ The PSScriptAnalyzer contains the following rule definitions.
5858
| [ProvideCommentHelp](./ProvideCommentHelp.md) | Information | Yes | Yes |
5959
| [ReservedCmdletChar](./ReservedCmdletChar.md) | Error | Yes | |
6060
| [ReservedParams](./ReservedParams.md) | Error | Yes | |
61-
| [ReviewUnusedParameter](./ReviewUnusedParameter.md) | Warning | Yes | |
61+
| [ReviewUnusedParameter](./ReviewUnusedParameter.md) | Warning | Yes | Yes<sup>2</sup> |
6262
| [ShouldProcess](./ShouldProcess.md) | Warning | Yes | |
6363
| [UseApprovedVerbs](./UseApprovedVerbs.md) | Warning | Yes | |
6464
| [UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning | Yes | |
@@ -84,5 +84,5 @@ The PSScriptAnalyzer contains the following rule definitions.
8484

8585
- <sup>1</sup> Rule is not available on all PowerShell versions, editions, or OS platforms. See the
8686
rule's documentation for details.
87-
- <sup>2</sup> The rule a configurable property, but the rule can't be disabled like other
87+
- <sup>2</sup> The rule has a configurable property, but the rule can't be disabled like other
8888
configurable rules.

docs/Rules/UseSingularNouns.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Cmdlet Singular Noun
33
ms.custom: PSSA v1.22.0
4-
ms.date: 03/26/2024
4+
ms.date: 03/27/2024
55
ms.topic: reference
66
title: UseSingularNouns
77
---
@@ -25,24 +25,24 @@ function Get-Elements {
2525

2626
```powershell
2727
Rules = @{
28-
UseSingularNouns = @{
29-
NounAllowList = 'Data', 'Windows', 'Foos'
28+
PSUseSingularNouns = @{
3029
Enable = $true
30+
NounAllowList = 'Data', 'Windows', 'Foos'
3131
}
3232
}
3333
```
3434

3535
### Parameters
3636

37-
- `UseSingularNouns`: `string[]` (Default value is `{'Data', 'Windows'}`)
38-
39-
Commands to be excluded from this rule. `Data` and `Windows` are common false positives and are
40-
excluded by default.
41-
4237
- `Enable`: `bool` (Default value is `$true`)
4338

4439
Enable or disable the rule during ScriptAnalyzer invocation.
4540

41+
- `NounAllowList`: `string[]` (Default value is `{'Data', 'Windows'}`)
42+
43+
Commands to be excluded from this rule. `Data` and `Windows` are common false positives and are
44+
excluded by default.
45+
4646
## How
4747

4848
Change plurals to singular.

0 commit comments

Comments
 (0)