Fix ScriptAnalyzer warnings

viscalyx · Jul 12, 2024 · 60ea8d1 · 60ea8d1
1 parent 6fd9fd9
commit 60ea8d1
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 11 deletions.
diff --git a/source/Private/Get-AstDefinition.ps1 b/source/Private/Get-AstDefinition.ps1
@@ -23,13 +23,7 @@
         Retrieves the ScriptBlockAst definition of the 'Script.ps1' file.
 
     .EXAMPLE
-        'C:\Scripts\Script.ps1' | Get-AstDefinition
-
-        Retrieves the ScriptBlockAst definition of the 'Script.ps1' file using
-        pipeline input.
-
-    .EXAMPLE
-        Get-ChildItem -Path './scripts' | Get-AstDefinition
+        Get-AstDefinition -Path (Get-ChildItem -Path './scripts')
 
         Retrieves the ScriptBlockAst definition of all the files in the path pass
         as pipeline input.

diff --git a/source/Private/Get-CommandAst.ps1 b/source/Private/Get-CommandAst.ps1
@@ -14,7 +14,7 @@
         Specifies the PowerShell command for which to retrieve the AST.
 
     .EXAMPLE
-        Get-CommandAst -Command 'Should'
+        Get-CommandAst -CommandName 'Should'
 
         This example retrieves the AST of the 'Should' command.
 

diff --git a/source/Private/Get-PesterCommandParameter.ps1 b/source/Private/Get-PesterCommandParameter.ps1
@@ -30,7 +30,7 @@
 
     .EXAMPLE
         $commandAst = [System.Management.Automation.Language.Parser]::ParseInput('Should -Be "ExpectedString" "BecauseString" "ActualString"')
-        Get-PesterCommandParameter -CommandAst $commandAst -IgnoreParameter 'Be', 'Not' -PositionalParameter 'ExpectedValue', 'Because', 'ActualValue'
+        Get-PesterCommandParameter -CommandAst $commandAst -CommandName 'Should' -IgnoreParameter @('Be', 'Not') -PositionalParameter @('ExpectedValue', 'Because', 'ActualValue')
 
         Returns a hashtable with the parameters.
 #>

diff --git a/source/Private/Get-PesterCommandSyntaxVersion.ps1 b/source/Private/Get-PesterCommandSyntaxVersion.ps1
@@ -21,7 +21,7 @@
 
     .EXAMPLE
         $ast = [System.Management.Automation.Language.Parser]::ParseInput('Should -BeExactly "value"', [ref]$null, [ref]$null)
-        Get-PesterCommandSyntaxVersion -CommandAst $ast -CommandName 'Should' -ParameterName 'BeExactly'
+        Get-PesterCommandSyntaxVersion -CommandAst $ast
 
         Returns the syntax version for the 'Should -BeExactly' command.
 #>

diff --git a/source/Public/Convert-PesterSyntax.ps1 b/source/Public/Convert-PesterSyntax.ps1
@@ -36,7 +36,7 @@
         Converts the syntax of the Test.ps1 file to Pester 6 syntax.
 
     .EXAMPLE
-        Get-ChildItem -Path "C:\Scripts" -Recurse -Filter "*.ps1" | Convert-PesterSyntax
+        Get-ChildItem -Path "C:\Scripts" -Recurse -Filter "*.ps1" | Convert-PesterSyntax -Pester6
 
         Converts the syntax of all PowerShell files in the C:\Scripts directory and
         its subdirectories to the default (newest) Pester syntax.