Skip to content

Commit 577b9e2

Browse files
committed
Cleaned up the wording a bit more in the about help topic.
1 parent 90aa28f commit 577b9e2

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Engine/about_PSScriptAnalyzer.help.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ RUNNING SCRIPT ANALYZER
3838
That will analyze your script against every built-in rule. As you may find
3939
if your script is sufficiently large, that could result in a lot of warnings
4040
and/or errors. See the next section on recommendations for running against
41-
an existing script or module.
41+
an existing script, module or DSC resource.
4242

4343
To run the script analyzer against a whole directory, specify the folder
4444
containing the script, module and DSC files you want analyzed. Specify
45-
the Recurse parameter if you also want sub-directories searched for scripts
45+
the Recurse parameter if you also want sub-directories searched for files
4646
to analyze.
4747

4848
PS C:\> Invoke-ScriptAnalyzer -Path . -Recurse
@@ -59,9 +59,9 @@ RUNNING SCRIPT ANALYZER ON A NEW SCRIPT, MODULE OR DSC RESOURCE
5959
soon as they occur.
6060

6161
Over time, you may find rules that you don't find value in or have a need to
62-
violate the rule. Suppress those rules as necessary but try to avoid
63-
"knee jerk" rule suppression. Analyze the diagnostic output and the part of
64-
your script that violates the rule to be sure you understand the reason for
62+
explicitly violate. Suppress those rules as necessary but try to avoid
63+
"knee jerk" suppression of rules. Analyze the diagnostic output and the part
64+
of your script that violates the rule to be sure you understand the reason for
6565
the warning and that it is indeed OK to suppress the rule.
6666

6767
There are several ways to suppress rules. You can suppress a rule globally
@@ -70,11 +70,11 @@ RUNNING SCRIPT ANALYZER ON A NEW SCRIPT, MODULE OR DSC RESOURCE
7070
PS C:\> Invoke-ScriptAnalyzer -Path . -ExcludeRule `
7171
PSProvideDefaultParameterValue, PSAvoidUsingWMICmdlet
7272

73-
Note that ExcludeRule parameter takes an array of strings i.e. rule names.
73+
Note that the ExcludeRule parameter takes an array of strings i.e. rule names.
7474

75-
Sometimes you want to suppress a rule for part of your script but not for
75+
Sometimes you will want to suppress a rule for part of your script but not for
7676
the entire script. PSScriptAnalyzer allows you to suppress rules at the
77-
function level as well. You can use the .NET Framework
77+
script, function and class scope. You can use the .NET Framework
7878
System.Diagnoctics.CodeAnalysis.SuppressMesssageAttribute in your script
7979
like so:
8080

0 commit comments

Comments
 (0)