From 0857dbabc326ce03501466d46d7628179b56abd9 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 23 Jul 2026 13:43:12 -0500 Subject: [PATCH] Sync PSSA docs changes from repo --- .../Rules/UseConsistentParametersKind.md | 9 ++++++++- .../PSScriptAnalyzer/Rules/UseSingularNouns.md | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md index acb5abf..1ddc79d 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseConsistentParametersKind.md @@ -1,6 +1,6 @@ --- description: Use the same pattern when defining parameters -ms.date: 07/21/2026 +ms.date: 07/23/2026 ms.topic: reference title: UseConsistentParametersKind --- @@ -43,6 +43,7 @@ function g { Rules = @{ PSUseConsistentParametersKind = @{ Enable = $true + ParametersKind = 'ParamBlock' } } ``` @@ -53,3 +54,9 @@ Rules = @{ This parameter controls whether ScriptAnalyzer checks the code against this rule. It accepts a boolean value. To enable this rule, set this parameter to `$true`. The default value is `$false`. + +## ParametersKind + +Use this parameter to specify the type of parameter definition pattern that should be used +consistently across all functions. It accepts a string value, which can be either `Inline` or +`ParamBlock`. The default value is `ParamBlock`. diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md index 8934595..c38bae0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md @@ -68,6 +68,6 @@ boolean value. To disable this rule, set this parameter to `$false`. The default ### NounAllowList -This parameter specifies which noun commands to exclude from this rule. It accepts a string value. +This parameter specifies which noun commands to exclude from this rule. It accepts a string array. Both `Data` and `Windows` are common false positives and excluded by default. Default values are `'Data'` and `'Windows'`.