Missing configurable property in README.md; Fix rule name, param na…

…me, (#213) and example in `UseSingularNouns.md`
MicrosoftDocs · Mar 27, 2024 · 38931dc · 38931dc
1 parent 2b8021a
commit 38931dc
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md
@@ -1,7 +1,7 @@
 ---
 description: List of PSScriptAnalyzer rules
 ms.custom: PSSA v1.22.0
-ms.date: 02/13/2024
+ms.date: 03/27/2024
 ms.topic: reference
 title: List of PSScriptAnalyzer rules
 ---
@@ -58,7 +58,7 @@ The PSScriptAnalyzer contains the following rule definitions.
 | [ProvideCommentHelp](./ProvideCommentHelp.md)                                                     | Information |        Yes         |       Yes       |
 | [ReservedCmdletChar](./ReservedCmdletChar.md)                                                     | Error       |        Yes         |                 |
 | [ReservedParams](./ReservedParams.md)                                                             | Error       |        Yes         |                 |
-| [ReviewUnusedParameter](./ReviewUnusedParameter.md)                                               | Warning     |        Yes         |                 |
+| [ReviewUnusedParameter](./ReviewUnusedParameter.md)                                               | Warning     |        Yes         | Yes<sup>2</sup> |
 | [ShouldProcess](./ShouldProcess.md)                                                               | Warning     |        Yes         |                 |
 | [UseApprovedVerbs](./UseApprovedVerbs.md)                                                         | Warning     |        Yes         |                 |
 | [UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md)                                   | Warning     |        Yes         |                 |
@@ -84,5 +84,5 @@ The PSScriptAnalyzer contains the following rule definitions.
 
 - <sup>1</sup> Rule is not available on all PowerShell versions, editions, or OS platforms. See the
   rule's documentation for details.
-- <sup>2</sup> The rule a configurable property, but the rule can't be disabled like other
+- <sup>2</sup> The rule has a configurable property, but the rule can't be disabled like other
   configurable rules.
diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md
@@ -1,7 +1,7 @@
 ---
 description: Cmdlet Singular Noun
 ms.custom: PSSA v1.22.0
-ms.date: 03/26/2024
+ms.date: 03/27/2024
 ms.topic: reference
 title: UseSingularNouns
 ---
@@ -25,24 +25,24 @@ function Get-Elements {
 
 ```powershell
 Rules = @{
-    UseSingularNouns = @{
-        NounAllowList    = 'Data', 'Windows', 'Foos'
+    PSUseSingularNouns = @{
         Enable           = $true
+        NounAllowList    = 'Data', 'Windows', 'Foos'
     }
 }
 ```
 
 ### Parameters
 
-- `UseSingularNouns`: `string[]` (Default value is `{'Data', 'Windows'}`)
-
-  Commands to be excluded from this rule. `Data` and `Windows` are common false positives and are
-  excluded by default.
-
 - `Enable`: `bool` (Default value is `$true`)
 
   Enable or disable the rule during ScriptAnalyzer invocation.
 
+- `NounAllowList`: `string[]` (Default value is `{'Data', 'Windows'}`)
+
+  Commands to be excluded from this rule. `Data` and `Windows` are common false positives and are
+  excluded by default.
+
 ## How
 
 Change plurals to singular.