Merge pull request #5730 from Youssef1313/patch-2

Fix markdown issues

Author: ghogen

docs/code-quality/ca1031.md

@@ -57,8 +57,8 @@ dotnet_code_quality.CA1031.disallowed_symbol_names = NullReferenceException
 ```
 
 Allowed type name formats in the option value (separated by '|'):
-  - Type name only (includes all symbols with the name, regardless of the containing type or namespace)
-  - Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format) with a `T:` prefix.
+- Type name only (includes all symbols with the name, regardless of the containing type or namespace)
+- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format) with a `T:` prefix.
 
 Examples:
 

docs/code-quality/ca1062.md

@@ -70,8 +70,8 @@ dotnet_code_quality.CA1062.null_check_validation_methods = Validate
 ```
 
 Allowed method name formats in the option value (separated by '|'):
-  - Method name only (includes all methods with the name, regardless of the containing type or namespace)
-  - Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format), with an optional `M:` prefix.
+- Method name only (includes all methods with the name, regardless of the containing type or namespace)
+- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format), with an optional `M:` prefix.
 
 Examples:
 
@@ -91,9 +91,9 @@ dotnet_code_quality.CA1062.excluded_symbol_names = MyType
 ```
 
 Allowed symbol name formats in the option value (separated by '|'):
-  - Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
-  - Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format). Each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
-  - `.ctor` for constructors and `.cctor` for static constructors
+- Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
+- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format). Each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
+- `.ctor` for constructors and `.cctor` for static constructors
 
 Examples:
 

docs/code-quality/ca1507.md

@@ -39,8 +39,6 @@ Rule CA1507 flags the use of a `string` literal as an argument to a method or co
 
   - The declared name of the parameter is `propertyName` and the constant value of the `string` literal matches the name of a property of the type within which the method or constructor is being invoked.
 
-
-
 Rule CA1507 improves code maintainability in cases where the parameter may be renamed in the future, but the `string` literal is mistakenly not renamed. By using `nameof`, the symbol will be renamed when the parameter is renamed through a refactoring operation. In addition, any spelling mistakes in the name of the parameter are caught by the compiler.
 
 > [!NOTE]

docs/code-quality/ca1509.md

@@ -62,7 +62,6 @@ An invalid entry in this configuration file is flagged with the `CA1509` diagnos
 > [!NOTE]
 > Rule CA1509 is not available in legacy analysis. It was first introduced in [FxCop analyzers](https://www.nuget.org/packages/Microsoft.CodeAnalysis.FxCopAnalyzers) version 2.9.6.
 
-
 ## How to fix violations
 
 To fix a violation of this rule, make sure the invalid entry in `CodeMetricsConfig.txt` gets the required format.

docs/code-quality/ca1826.md

@@ -67,7 +67,6 @@ class C
 }
 ```
 
-
 ```csharp
 using System;
 using System.Collections.Generic;

docs/code-quality/ca1827.md

@@ -51,7 +51,6 @@ class C
 }
 ```
 
-
 ```csharp
 using System.Collections.Generic;
 using System.Linq;

docs/code-quality/ca1828.md

@@ -52,7 +52,6 @@ class C
 }
 ```
 
-
 ```csharp
 using System.Linq;
 using System.Threading.Tasks;

docs/code-quality/ca1829.md

@@ -64,7 +64,6 @@ class C
 }
 ```
 
-
 ```csharp
 using System.Collections.Generic;
 

docs/code-quality/ca1833.md

@@ -53,7 +53,7 @@ class C
     {
         // The violation occurs for both statements below
         Span<byte> tmp2 = arr[0..5];
-        Memory<byte> tmp4 = arr[5..10];		
+        Memory<byte> tmp4 = arr[5..10];
         ...
     }
 }
@@ -66,7 +66,7 @@ class C
     {
         // The violations fixed with AsSpan or AsMemory accordingly
         Span<byte> tmp2 = arr.AsSpan()[0..5];
-        Memory<byte> tmp4 = arr.AsMemory()[5..10];	
+        Memory<byte> tmp4 = arr.AsMemory()[5..10];
         ...
     }
 }
@@ -88,8 +88,8 @@ class C
     {
         // The violation occurs
         Span<byte> tmp1 = arr[0..5];
-        Memory<byte> tmp2 = arr[5..10];	
-		...
+        Memory<byte> tmp2 = arr[5..10];
+        ...
     }
 }
 ```

docs/code-quality/ca1835.md

@@ -64,6 +64,7 @@ The rule can detect a variety of violations for the `ReadAsync` and `WriteAsync`
 ##### Example 1
 
 Invocations of `ReadAsync`, without and with a `CancellationToken` argument:
+
 ```cs
 using System;
 using System.IO;
@@ -82,7 +83,9 @@ class MyClass
     }
 }
 ```
+
 ##### Fix
+
 ```cs
 using System;
 using System.IO;
@@ -105,6 +108,7 @@ class MyClass
 ##### Example 2
 
 Invocations of `WriteAsync`, without and with a `CancellationToken` argument:
+
 ```cs
 using System;
 using System.IO;
@@ -123,7 +127,9 @@ class MyClass
     }
 }
 ```
+
 ##### Fix
+
 ```cs
 using System;
 using System.IO;
@@ -167,7 +173,9 @@ class MyClass
     }
 }
 ```
+
 ##### Fix
+
 ```cs
 using System;
 using System.IO;
@@ -196,6 +204,7 @@ Here are some examples of invocations where the rule will **not** be fired:
 ##### Example 1
 
 The return value is saved in a `Task` variable instead of being awaited:
+
 ```cs
 using System;
 using System.IO;
@@ -218,6 +227,7 @@ class MyClass
 ##### Example 2
 
 The return value is returned by the wrapping method instead of being awaited:
+
 ```cs
 using System;
 using System.IO;
@@ -236,6 +246,7 @@ class MyClass
 ##### Example 3
 
 The return value is used to call `ContinueWith`, which is the method being awaited:
+
 ```cs
 using System;
 using System.IO;
@@ -261,4 +272,4 @@ It's safe to suppress a violation of this rule if you're not concerned about imp
 
 ## See also
 
-- [Performance warnings](../code-quality/performance-warnings.md)
+- [Performance warnings](../code-quality/performance-warnings.md)

docs/code-quality/ca1836.md

@@ -46,7 +46,6 @@ class C
 }
 ```
 
-
 ```csharp
 using System.Collections.Concurrent;
 

docs/code-quality/ca2000.md

@@ -89,9 +89,9 @@ dotnet_code_quality.CA2000.excluded_symbol_names = MyType
 ```
 
 Allowed symbol name formats in the option value (separated by '|'):
-  - Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
-  - Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format). Each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
-  - `.ctor` for constructors and `.cctor` for static constructors
+- Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
+- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format). Each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
+- `.ctor` for constructors and `.cctor` for static constructors
 
 Examples:
 

docs/code-quality/ca2009.md

@@ -78,7 +78,6 @@ public class C
 }
 ```
 
-
 ```csharp
 using System;
 using System.Collections.Generic;

docs/code-quality/ca2013.md

@@ -37,10 +37,10 @@ To fix the violation, replace it with a more appropriate equality check such as
 ```csharp
 
     int int1 = 1, int2 = 1;
-	
+
     // Violation occurs, returns false.
     Console.WriteLine(Object.ReferenceEquals(int1, int2));  // false
-	
+
     // Use appropriate equality operator or method instead
     Console.WriteLine(int1 == int2);                        // true
     Console.WriteLine(Object.Equals(int1, int2));           // true

docs/code-quality/ca2015.md

@@ -47,9 +47,9 @@ class DerivedClass <T> : MemoryManager<T>
             _handle.Dispose();
         }
     }
-	
+
     ...
-	
+
     // Violation occurs, remove the finalizer to fix the warning.
     ~DerivedClass() => Dispose(false);
 }

docs/code-quality/ca2016.md

@@ -76,6 +76,7 @@ namespace ConsoleApp
 ##### Fix
 
 Forward the `c` parameter:
+
 ```csharp
         public static void MyMethod(CancellationToken c)
         {
@@ -86,6 +87,7 @@ Forward the `c` parameter:
 If you are not concerned about forwarding cancellation notifications to lower invocations, you can either:
 
 Explicitly pass `default`:
+
 ```csharp
         public static void MyMethod(CancellationToken c)
         {
@@ -94,6 +96,7 @@ Explicitly pass `default`:
 ```
 
 Or explicitly pass `CancellationToken.None`:
+
 ```csharp
         public static void MyMethod(CancellationToken c)
         {
@@ -131,6 +134,7 @@ namespace ConsoleApp
 ##### Fix
 
 Forward the `c` parameter:
+
 ```csharp
         public static void MyMethod(CancellationToken c)
         {
@@ -141,6 +145,7 @@ Forward the `c` parameter:
 If you are not concerned about forwarding cancellation notifications to lower invocations, you can either:
 
 Explicitly pass `default`:
+
 ```csharp
         public static void MyMethod(CancellationToken c)
         {
@@ -149,14 +154,14 @@ Explicitly pass `default`:
 ```
 
 Or explicitly pass `CancellationToken.None`:
+
 ```csharp
         public static void MyMethod(CancellationToken c)
         {
             MyMethodWithOverload(CancellationToken.None);
         }
 ```
 
-
 #### No diagnosis
 
 ##### Example 1

docs/code-quality/ca2100.md

@@ -89,9 +89,9 @@ dotnet_code_quality.CA2100.excluded_symbol_names = MyType
 ```
 
 Allowed symbol name formats in the option value (separated by '|'):
-  - Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
-  - Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format). Each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
-  - `.ctor` for constructors and `.cctor` for static constructors
+- Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
+- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format). Each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
+- `.ctor` for constructors and `.cctor` for static constructors
 
 Examples:
 

docs/code-quality/ca2208.md

@@ -76,6 +76,7 @@ If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (
 ```ini
 dotnet_code_quality.ca2208.api_surface = public
 ```
+
 By default CA2208 rules apply for all API surface (public, internal and private). You can configure this option for just this rule, for all rules, or for all rules in this category (Design). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).
 
 ## Example

docs/code-quality/ca2225.md

@@ -66,8 +66,8 @@ This rule examines:
 |!|N/A|!|LogicalNot|
 |%|Mod|%|Mod or Remainder|
 |%=|N/A|%=|Mod|
-|* (binary)|*|*|Multiply|
-|*=|N/A|*=|Multiply|
+|\* (binary)|\*|\*|Multiply|
+|\*=|N/A|\*=|Multiply|
 |~|Not|~|OnesComplement|
 |>>|>>|>>|RightShift|
 =|N/A|>>=|RightShift|
@@ -78,7 +78,7 @@ This rule examines:
 |+ (unary)|N/A|+|Plus|
 |false|IsFalse|False|IsTrue (Property)|
 
-*N/A means the operator cannot be overloaded in the selected language.
+\*N/A means the operator cannot be overloaded in the selected language.
 
 > [!NOTE]
 > In C#, when a binary operator is overloaded, the corresponding assignment operator, if any, is also implicitly overloaded.

docs/code-quality/ca2241.md

@@ -54,8 +54,8 @@ dotnet_code_quality.CA2241.additional_string_formatting_methods = MyFormat
 ```
 
 Allowed method name formats in the option value (separated by '|'):
-  - Method name only (includes all methods with the name, regardless of the containing type or namespace)
-  - Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format), with an optional `M:` prefix.
+- Method name only (includes all methods with the name, regardless of the containing type or namespace)
+- Fully qualified names in the symbol's [documentation ID format](https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format), with an optional `M:` prefix.
 
 Examples:
 

docs/code-quality/ca2244.md

@@ -89,7 +89,6 @@ class C
 >
 > ![Code fix for CA2244 - Remove redundant element initializer](media/ca2244-codefix.png)
 
-
 ## When to suppress warnings
 
 Do not suppress violations for this rule.

docs/code-quality/ca2247.md

@@ -38,7 +38,7 @@ To fix the violation, replace the <xref:System.Threading.Tasks.TaskContinuationO
 ```csharp
     // Violation
     var tcs = new TaskCompletionSource<int>(TaskContinuationOptions.RunContinuationsAsynchronously);
-	
+
     // Fixed
     var tcs = new TaskCompletionSource<int>(TaskCreationOptions.RunContinuationsAsynchronously);
 ```
@@ -47,7 +47,6 @@ To fix the violation, replace the <xref:System.Threading.Tasks.TaskContinuationO
 
 A violation of this rule almost always highlights a bug in the calling code, such that the code will not behave as the developer intended, with the TaskCompletionSource effectively ignoring the specified option.  The only time it is safe to suppress the warning is if the developer actually intended to pass a boxed <xref:System.Threading.Tasks.TaskContinuationOptions?displayProperty=fullName> as the object state argument to the TaskCompletionSource.
 
-
 ## See also
 
 - [Usage warnings](../code-quality/usage-warnings.md)