Suppress PSReviewUnusedParameter false positive

krowlandson · Sep 3, 2020 · d7a9e02 · d7a9e02
1 parent 22065c5
commit d7a9e02
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/functions/New-AzStateDiscovery.ps1 b/functions/New-AzStateDiscovery.ps1
@@ -3,6 +3,14 @@
 #################################
 
 function Get-AzStateChildrenByType {
+    ###############################################
+    # Configure PSScriptAnalyzer rule suppression #
+    ###############################################
+
+    # The following SuppressMessageAttribute entries are used to surpress
+    # PSScriptAnalyzer tests against known exceptions as per:
+    # https://github.com/powershell/psscriptanalyzer#suppressing-rules
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'ExcludePathIds', Justification = 'False positive: used in process block of function')]
 
     [CmdletBinding()]
     [OutputType([AzState[]])]