Fixes the documentation of AvoidInvokingEmptyMembers rule.

kborle · kborle · commit 4bca8a839823 · 2015-10-21T11:31:26.000-07:00
diff --git a/RuleDocumentation/AvoidInvokingEmptyMembers.md b/RuleDocumentation/AvoidInvokingEmptyMembers.md
@@ -4,7 +4,7 @@
 
 ##Description
 
-Invoking non-constant members would cause potential bugs. Please double check the syntax to make sure members invoked are non-constant.
+Invoking non-constant members would cause potential bugs. Please double check the syntax to make sure that invoked members are constants.
 
 
 ##How to Fix
diff --git a/Rules/AvoidInvokingEmptyMembers.cs b/Rules/AvoidInvokingEmptyMembers.cs
@@ -20,14 +20,15 @@
 
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 {
+    // Rule name is inconsistent.
     /// <summary>
-    /// AvoidAlias: Check if cmdlet alias is used.
-    /// </summary>
+    /// AvoidInvokingEmptyMembers: Analyzes the script to check if any non-constant members have been invoked.
+    /// </summary>    
     [Export(typeof(IScriptRule))]
     public class AvoidInvokingEmptyMembers : IScriptRule
     {
         /// <summary>
-        /// AnalyzeScript: Analyze the script to check if any empty members has been invoked.
+        /// AnalyzeScript: Analyzes the script to check if any non-constant members have been invoked.
         /// </summary>
         public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         {

Original file line number	Diff line number	Diff line change
`@@ -20,14 +20,15 @@`
`20`	`20`
`21`	`21`	`namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules`
`22`	`22`	`{`
	`23`	`+ // Rule name is inconsistent.`
`23`	`24`	`/// <summary>`
`24`		`- /// AvoidAlias: Check if cmdlet alias is used.`
`25`		`- /// </summary>`
	`25`	`+ /// AvoidInvokingEmptyMembers: Analyzes the script to check if any non-constant members have been invoked.`
	`26`	`+ /// </summary>`
`26`	`27`	`[Export(typeof(IScriptRule))]`
`27`	`28`	`public class AvoidInvokingEmptyMembers : IScriptRule`
`28`	`29`	`{`
`29`	`30`	`/// <summary>`
`30`		`- /// AnalyzeScript: Analyze the script to check if any empty members has been invoked.`
	`31`	`+ /// AnalyzeScript: Analyzes the script to check if any non-constant members have been invoked.`
`31`	`32`	`/// </summary>`
`32`	`33`	`public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)`
`33`	`34`	`{`