Skip to content

Commit e4372eb

Browse files
committed
Correct rule name for consistency and to fix failing docs tests
1 parent ef4c0de commit e4372eb

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

Rules/UseSingleValueFromPipelineParameter.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,11 @@ private static string GetParameterSetForAttribute(AttributeAst attributeAst)
173173

174174
public string GetDescription() => Strings.UseSingleValueFromPipelineParameterDescription;
175175

176-
public string GetName() => Strings.UseSingleValueFromPipelineParameterName;
176+
public string GetName() => string.Format(
177+
CultureInfo.CurrentCulture,
178+
Strings.NameSpaceFormat,
179+
GetSourceName(),
180+
Strings.UseSingleValueFromPipelineParameterName);
177181

178182
public RuleSeverity GetSeverity() => RuleSeverity.Warning;
179183

Tests/Rules/UseSingleValueFromPipelineParameter.Tests.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Licensed under the MIT License.
33

44
BeforeAll {
5-
$ruleName = 'UseSingleValueFromPipelineParameter'
5+
$ruleName = 'PSUseSingleValueFromPipelineParameter'
66
}
77

88
Describe 'UseSingleValueFromPipelineParameter' {
@@ -309,7 +309,7 @@ function Test-Function {
309309
It 'Should be suppressible by parameter set name' {
310310
$scriptDefinition = @'
311311
function Test-Function {
312-
[Diagnostics.CodeAnalysis.SuppressMessage('UseSingleValueFromPipelineParameter', 'MySet')]
312+
[Diagnostics.CodeAnalysis.SuppressMessage('PSUseSingleValueFromPipelineParameter', 'MySet')]
313313
param(
314314
[Parameter(ValueFromPipeline=$true, ParameterSetName='MySet')]
315315
$InputObject,

docs/Rules/UseSingleValueFromPipelineParameter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ attribute with the parameter set name:
6969

7070
```powershell
7171
function Process-Data {
72-
[Diagnostics.CodeAnalysis.SuppressMessage('UseSingleValueFromPipelineParameter', 'MyParameterSet')]
72+
[Diagnostics.CodeAnalysis.SuppressMessage('PSUseSingleValueFromPipelineParameter', 'MyParameterSet')]
7373
[CmdletBinding()]
7474
param(
7575
[Parameter(ValueFromPipeline, ParameterSetName='MyParameterSet')]
@@ -93,7 +93,7 @@ For the default parameter set, use `'default'` as the suppression target:
9393
## Notes
9494

9595
- This rule applies to both explicit `ValueFromPipeline=$true` and implicit
96-
`ValueFromPipeline` (which defaults to `$true`)
96+
`ValueFromPipeline` (which is the same as using `=$true`)
9797
- Parameters with `ValueFromPipeline=$false` are not flagged by this rule
9898
- The rule correctly handles the default parameter set (`__AllParameterSets`)
9999
and named parameter sets

0 commit comments

Comments
 (0)