Merge pull request #742 from PowerShell/kapilmb/update-rule-docs

Kapil Borle · web-flow · commit 2114db7ad5bc · 2017-03-31T17:03:31.000-07:00
Make rule doc filenames consistent with rule names
diff --git a/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md b/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md
@@ -1,4 +1,4 @@
-# ProvideDefaultParameterValue
+# AvoidDefaultValueForMandatoryParameter
 
 **Severity Level: Warning**
 
diff --git a/RuleDocumentation/AvoidDefaultValueSwitchParameter.md b/RuleDocumentation/AvoidDefaultValueSwitchParameter.md
@@ -1,4 +1,4 @@
-# AvoidDefaultTrueValueSwitchParameter
+# AvoidDefaultValueSwitchParameter
 
 **Severity Level: Warning**
 
diff --git a/RuleDocumentation/AvoidUsingCmdletAliases.md b/RuleDocumentation/AvoidUsingCmdletAliases.md
@@ -1,4 +1,4 @@
-# AvoidAlias
+# AvoidUsingCmdletAliases
 
 **Severity Level: Warning**
 
diff --git a/RuleDocumentation/AvoidUsingEmptyCatchBlock.md b/RuleDocumentation/AvoidUsingEmptyCatchBlock.md
@@ -1,4 +1,4 @@
-# AvoidEmptyCatchBlock
+# AvoidUsingEmptyCatchBlock
 
 **Severity Level: Warning**
 
diff --git a/RuleDocumentation/MisleadingBacktick.md b/RuleDocumentation/MisleadingBacktick.md
@@ -0,0 +1,7 @@
+# MisleadingBacktick
+
+**Severity Level: Warning**
+
+## Description
+
+Checks that lines don't end with a backtick followed by whitespace.
diff --git a/RuleDocumentation/ReservedCmdletChar.md b/RuleDocumentation/ReservedCmdletChar.md
@@ -1,4 +1,4 @@
-# AvoidReservedCharInCmdlet
+# ReservedCmdletChar
 
 **Severity Level: Error**
 
diff --git a/RuleDocumentation/ReservedParams.md b/RuleDocumentation/ReservedParams.md
@@ -1,4 +1,4 @@
-# AvoidReservedParams
+# ReservedParams
 
 **Severity Level: Error**
 
diff --git a/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md b/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md
@@ -1,4 +1,4 @@
-# ReturnCorrectTypeDSCFunctions
+# ReturnCorrectTypesForDSCFunctions
 
 **Severity Level: Information**
 
diff --git a/RuleDocumentation/ShouldProcess.md b/RuleDocumentation/ShouldProcess.md
@@ -1,4 +1,4 @@
-# UseShouldProcessCorrectly
+# ShouldProcess
 
 **Severity Level: Warning**
 
diff --git a/RuleDocumentation/StandardDSCFunctionsInResource.md b/RuleDocumentation/StandardDSCFunctionsInResource.md
@@ -1,4 +1,4 @@
-# UseStandardDSCFunctionsInResource
+# StandardDSCFunctionsInResource
 
 **Severity Level: Error**
 
diff --git a/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md b/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md
@@ -1,4 +1,4 @@
-# UseIdenticalMandatoryParametersDSC
+# UseIdenticalMandatoryParametersForDSC
 
 **Severity Level: Error**
 
diff --git a/RuleDocumentation/UseIdenticalParametersForDSC.md b/RuleDocumentation/UseIdenticalParametersForDSC.md
@@ -1,4 +1,4 @@
-# UseIdenticalParametersDSC
+# UseIdenticalParametersForDSC
 
 **Severity Level: Error**
 
diff --git a/RuleDocumentation/UseUTF8EncodingForHelpFile.md b/RuleDocumentation/UseUTF8EncodingForHelpFile.md
@@ -0,0 +1,7 @@
+# UseUTF8EncodingForHelpFile
+
+**Severity Level: Warning**
+
+## Description
+
+Check if help file uses utf8 encoding
diff --git a/RuleDocumentation/UseVerboseMessageInDSCResource.md b/RuleDocumentation/UseVerboseMessageInDSCResource.md
@@ -1,4 +1,4 @@
-# ProvideVerboseMessage
+# UseVerboseMessageInDSCResource
 
 **Severity Level: Information**
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# ProvideDefaultParameterValue`
	`1`	`+# AvoidDefaultValueForMandatoryParameter`
`2`	`2`
`3`	`3`	`Severity Level: Warning`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# AvoidDefaultTrueValueSwitchParameter`
	`1`	`+# AvoidDefaultValueSwitchParameter`
`2`	`2`
`3`	`3`	`Severity Level: Warning`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# AvoidAlias`
	`1`	`+# AvoidUsingCmdletAliases`
`2`	`2`
`3`	`3`	`Severity Level: Warning`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# AvoidEmptyCatchBlock`
	`1`	`+# AvoidUsingEmptyCatchBlock`
`2`	`2`
`3`	`3`	`Severity Level: Warning`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# AvoidReservedCharInCmdlet`
	`1`	`+# ReservedCmdletChar`
`2`	`2`
`3`	`3`	`Severity Level: Error`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# AvoidReservedParams`
	`1`	`+# ReservedParams`
`2`	`2`
`3`	`3`	`Severity Level: Error`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# ReturnCorrectTypeDSCFunctions`
	`1`	`+# ReturnCorrectTypesForDSCFunctions`
`2`	`2`
`3`	`3`	`Severity Level: Information`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# UseShouldProcessCorrectly`
	`1`	`+# ShouldProcess`
`2`	`2`
`3`	`3`	`Severity Level: Warning`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# UseStandardDSCFunctionsInResource`
	`1`	`+# StandardDSCFunctionsInResource`
`2`	`2`
`3`	`3`	`Severity Level: Error`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# UseIdenticalMandatoryParametersDSC`
	`1`	`+# UseIdenticalMandatoryParametersForDSC`
`2`	`2`
`3`	`3`	`Severity Level: Error`
`4`	`4`