Skip to content

Commit d2057f1

Browse files
committed
Modified some wording
1 parent 296f091 commit d2057f1

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

CustomizedRuleDocumentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
##Documentation for Customized Rules in PowerShell Scripts
2-
PSScriptAnalyzer uses MEF(Managed Extensibility Framework) to import all rules defined in the assembly. It can also consume rules written in PowerShell scripts. When calling Invoke-ScriptAnalyzer, users can pass customized rules using parameter -CustomizedRule to apply rule checkings on the scripts.
2+
PSScriptAnalyzer uses MEF(Managed Extensibility Framework) to import all rules defined in the assembly. It can also consume rules written in PowerShell scripts. When calling Invoke-ScriptAnalyzer, users can pass customized rules using parameter -CustomizedRulePath to apply rule checkings on the scripts.
33

44
This documentation serves as a basic guideline on how to define customized rules.
55

66
###Basics
7-
1. Function should have comment-based help. Make sure .DESCRIPTION field is there, as it will be consumed as rule description for the customized rule.
7+
1. Functions should have comment-based help. Make sure .DESCRIPTION field is there, as it will be consumed as rule description for the customized rule.
88
```
99
<#
1010
.SYNOPSIS
@@ -21,7 +21,7 @@ This documentation serves as a basic guideline on how to define customized rules
2121
2. Output type should be DiagnosticRecord:
2222
[OutputType([Microsoft.Windows.Powershell.ScriptAnalyzer.Generic.DiagnosticRecord[]])]
2323

24-
3. Make sure the function takes either a Token or an Ast as a parameter
24+
3. Make sure each function takes either a Token or an Ast as a parameter
2525
```
2626
Param
2727
(

0 commit comments

Comments
 (0)