Update headings for case consistency

DotNetAnalyzers · Aug 24, 2015 · 1450ae9 · 1450ae9
1 parent e42d22f
commit 1450ae9
Show file tree

Hide file tree

Showing 163 changed files with 488 additions and 488 deletions.
diff --git a/documentation/SA1000.md b/documentation/SA1000.md
@@ -19,7 +19,7 @@
 
 The spacing around a C# keyword is incorrect.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around a keyword is incorrect.
 
@@ -29,11 +29,11 @@ The following keywords must not be followed by any space: *checked, default, siz
 
 The *new* keyword should always be followed by a space, unless it is used to create a new array, in which case there should be no space between the *new* keyword and the opening array bracket.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, add or remove a space after the keyword, according to the description above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1000:KeywordsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1001.md b/documentation/SA1001.md
@@ -19,17 +19,17 @@
 
 The spacing around a comma is incorrect, within a C# code file.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around a comma is incorrect.
 
 A comma should always be followed by a single space, unless it is the last character on the line, and a comma should never be preceded by any whitespace, unless it is the first character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the comma is followed by a single space, and is not preceded by any space.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1001:CommasMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1002.md b/documentation/SA1002.md
@@ -19,17 +19,17 @@
 
 The spacing around a semicolon is incorrect, within a C# code file.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around a semicolon is incorrect.
 
 A semicolon should always be followed by a single space, unless it is the last character on the line, and a semicolon should never be preceded by any whitespace, unless it is the first character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the semicolon is followed by a single space, and is not preceded by any space.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1002:SemicolonsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1003.md b/documentation/SA1003.md
@@ -19,7 +19,7 @@
 
 The spacing around an operator symbol is incorrect, within a C# code file.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around an operator symbol is incorrect.
 
@@ -43,11 +43,11 @@ if (!value)
 }
 ```
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the spacing around the symbol follows the rule described above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1003:SymbolsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1004.md b/documentation/SA1004.md
@@ -19,7 +19,7 @@
 
 A line within a documentation header above a C# element does not begin with a single space.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when a line within a documentation header does not begin with a single space. For example:
 
@@ -47,11 +47,11 @@ private void Method1(int x, int y)
 }
 ```
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the header line begins with a single space.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1004:DocumentationLinesMustBeginWithSingleSpace", Justification = "Reviewed.")]

diff --git a/documentation/SA1005.md b/documentation/SA1005.md
@@ -19,7 +19,7 @@
 
 A single-line comment within a C# code file does not begin with a single space.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when a single-line comment does not begin with a single space. For example:
 
@@ -51,11 +51,11 @@ private void Method1()
 }
 ```
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the comment begins with a single space. If the comment is being used to comment out a line of code, ensure that the comment begins with four forward slashes, in which case the leading space can be omitted.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1005:SingleLineCommentsMustBeginWithSingleSpace", Justification = "Reviewed.")]

diff --git a/documentation/SA1006.md b/documentation/SA1006.md
@@ -19,7 +19,7 @@
 
 A C# preprocessor-type keyword is preceded by space.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the preprocessor-type keyword in a preprocessor directive is preceded by space. For example:
 
@@ -33,11 +33,11 @@ There should not be any whitespace between the opening hash mark and the preproc
 #if Debug
 ```
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that there is no whitespace between the opening hash mark and the preprocessor-type keyword.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1006:PreprocessorKeywordsMustNotBePrecededBySpace", Justification = "Reviewed.")]

diff --git a/documentation/SA1007.md b/documentation/SA1007.md
@@ -19,7 +19,7 @@
 
 The operator keyword within a C# operator overload method is not followed by any whitespace.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the operator keyword within an operator overload method is not followed by any whitespace. The operator keyword should always be followed by a single space. For example:
 
@@ -29,11 +29,11 @@ public MyClass operator +(MyClass a, MyClass b)
 }
 ```
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, add a single space after the operator keyword.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1007:OperatorKeywordMustBeFollowedBySpace", Justification = "Reviewed.")]

diff --git a/documentation/SA1008.md b/documentation/SA1008.md
@@ -19,17 +19,17 @@
 
 An opening parenthesis within a C# statement is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the opening parenthesis within a statement is not spaced correctly. An opening parenthesis should not be preceded by any whitespace, unless it is the first character on the line, or it is preceded by certain C# keywords such as if, while, or for. In addition, an opening parenthesis is allowed to be preceded by whitespace when it follows an operator symbol within an expression.
 
 An opening parenthesis should not be followed by whitespace, unless it is the last character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the spacing around the opening parenthesis follows the rule described above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1008:OpeningParenthesisMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1009.md b/documentation/SA1009.md
@@ -19,19 +19,19 @@
 
 A closing parenthesis within a C# statement is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the closing parenthesis within a statement is not spaced correctly.
 
 A closing parenthesis should never be preceded by whitespace. In most cases, a closing parenthesis should be followed by a single space, unless the closing parenthesis comes at the end of a cast, or the closing parenthesis is followed by certain types of operator symbols, such as positive signs, negative signs, and colons.
 
 If the closing parenthesis is followed by whitespace, the next non-whitespace character must not be an opening or closing parenthesis or square bracket, or a semicolon or comma.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the spacing around the closing parenthesis follows the rule described above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1009:ClosingParenthesisMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1010.md b/documentation/SA1010.md
@@ -19,17 +19,17 @@
 
 An opening square bracket within a C# statement is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when an opening square bracket within a statement is preceded or followed by whitespace.
 
 An opening square bracket must never be preceded by whitespace, unless it is the first character on the line, and an opening square must never be followed by whitespace, unless it is the last character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that there is no whitespace on either side of the opening square bracket.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1010:OpeningSquareBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1011.md b/documentation/SA1011.md
@@ -19,19 +19,19 @@
 
 A closing square bracket within a C# statement is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around a closing square bracket is not correct.
 
 A closing square bracket must never be preceded by whitespace, unless it is the first character on the line.
 
 A closing square bracket must be followed by whitespace, unless it is the last character on the line, it is followed by a closing bracket or an opening parenthesis, it is followed by a comma or semicolon, or it is followed by certain types of operator symbols.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the spacing around the closing square bracket follows the rule described above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1011:ClosingSquareBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1012.md b/documentation/SA1012.md
@@ -19,19 +19,19 @@
 
 An opening curly bracket within a C# element is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around an opening curly bracket is not correct.
 
 An opening curly bracket should always be preceded by a single space, unless it is the first character on the line, or unless it is preceded by an opening parenthesis, in which case there should be no space between the parenthesis and the curly bracket.
 
 An opening curly bracket must always be followed by a single space, unless it is the last character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the spacing around the opening curly bracket follows the rule described above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1012:OpeningCurlyBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1013.md b/documentation/SA1013.md
@@ -19,19 +19,19 @@
 
 A closing curly bracket within a C# element is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around a closing curly bracket is not correct.
 
 A closing curly bracket should always be followed by a single space, unless it is the last character on the line, or unless it is followed by a closing parenthesis, a comma, or a semicolon.
 
 A closing curly bracket must always be preceded by a single space, unless it is the first character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that the spacing around the closing curly bracket follows the rule described above.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1013:ClosingCurlyBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1014.md b/documentation/SA1014.md
@@ -19,17 +19,17 @@
 
 An opening generic bracket within a C# element is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around an opening generic bracket is not correct.
 
 An opening generic bracket should never be preceded or followed by whitespace, unless the bracket is the first or last character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that there is no whitespace on either side of the opening generic bracket.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1014:OpeningGenericBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1015.md b/documentation/SA1015.md
@@ -19,7 +19,7 @@
 
 A closing generic bracket within a C# element is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around a closing generic bracket is not correct.
 
@@ -28,12 +28,12 @@ A closing generic bracket should never be preceded by whitespace, unless the bra
                     parenthesis, a closing generic bracket, a nullable symbol, an end of 
                     line or a single whitespace (but not whitespace and an open parenthesis).
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure the whitespace around the closing generic bracket 
                     is correct.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1015:ClosingGenericBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]

diff --git a/documentation/SA1016.md b/documentation/SA1016.md
@@ -19,17 +19,17 @@
 
 An opening attribute bracket within a C# element is not spaced correctly.
 
-## Rule Description
+## Rule description
 
 A violation of this rule occurs when the spacing around an opening attribute bracket is not correct.
 
 An opening attribute bracket should never be followed by whitespace, unless the bracket is the last character on the line.
 
-## How to Fix Violations
+## How to fix violations
 
 To fix a violation of this rule, ensure that there is no whitespace after the opening attribute bracket.
 
-## How to Suppress Violations
+## How to suppress violations
 
 ```csharp
 [SuppressMessage("StyleCop.CSharp.SpacingRules", "SA1016:OpeningAttributeBracketsMustBeSpacedCorrectly", Justification = "Reviewed.")]