Skip to content

fix: MD027/no-multiple-space-blockquote #3119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"MD024": false,
"MD025": false,
"MD026": false,
"MD027": false,
"MD028": false,
"MD029": false,
"MD032": false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ This article describes typical uses of annotations for simple function parameter
In the following table, additional substrings are inserted into the annotation name to further qualify the meaning of the annotation. The various substrings are `_z`, `_COM_`, `_buffer_`, `_bytebuffer_`, and `_to_`.

> [!IMPORTANT]
> If the interface that you are annotating is COM, use the COM form of these annotations. Do not use the COM annotations with any other type interface.
> If the interface that you are annotating is COM, use the COM form of these annotations. Do not use the COM annotations with any other type interface.

**Annotations and Descriptions**

Expand Down Expand Up @@ -465,7 +465,7 @@ This article describes typical uses of annotations for simple function parameter
The parameter, field, or result is in the range (inclusive) from `low` to `hi`. Equivalent to `_Satisfies_(_Curr_ >= low && _Curr_ <= hi)` that is applied to the annotated object together with the appropriate pre-state or post-state conditions.

> [!IMPORTANT]
> Although the names contain "in" and "out", the semantics of `_In_` and `_Out_` do **not** apply to these annotations.
> Although the names contain "in" and "out", the semantics of `_In_` and `_Out_` do **not** apply to these annotations.

- `_Pre_equal_to_(expr)`

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6500.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6500: invalid annotation: value for \<name> property is invalid

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that a property value used in the annotation is not valid. For example, it can occur if an incorrect level of dereference is used in the Deref property, or if you use a constant value that is larger than size_t for properties like ElementSize.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6501.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6501: annotation conflict: \<name> property conflicts with previously specified property

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates the presence of conflicting properties in the annotation. This typically occurs when multiple properties that serve similar purpose are used to annotate a parameter or return value. To correct the warning, you must choose the property that best addresses your need.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6503.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6503: Invalid annotation: references and arrays may not be marked Null=Yes or Null=Maybe

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that Null property is incorrectly used on a reference or array type. A reference or array type holds the address of an object and must point to a valid object. Because reference and array types cannot be null, you must correct the error by either removing the Null property or by setting the Null property value to No.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6508.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6508: invalid annotation: write access is not allowed on const values

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that the Access property specified on a const parameter implies that it can be written to. For constant values, Access=Read is the only valid setting.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6511.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6511: invalid annotation: MustCheck property must be Yes or No

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates an invalid value for MustCheck property was specified. The only valid values for this property are: Yes and No.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6513.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6513: invalid annotation: ElementSizeConst requires additional size properties

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that ElementSizeConst requires other properties that are missing from the annotation. Specifying ElementSizeConst alone does not provide any benefit to the analysis process. In addition to specifying ElementSize, other properties such as ValidElementsConst or WritableElementsConst must also be specified.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6516.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6516: invalid annotation: no properties specified for \<name> attribute

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that either no property was specified in the attribute or the property that was specified is invalid; therefore, the attribute cannot be considered complete.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6517.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6517: Invalid annotation: 'SAL_readableTo' property may not be specified on buffers that are not readable: '\_Param\_(1)'.

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that `SAL_readableTo` property does not have the required read access. You cannot use this property to annotate a parameter without providing read access.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6522.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6522: invalid size specification: expression must be of integral type

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that an integral type was expected, but an incorrect data type was used. You can use annotation properties that accept the size of a parameter in terms of another parameter, but you must use correct data type. For a list of annotation properties, see [Using SAL Annotations to reduce code defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6525.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning C6525: invalid size specification: property value may not be valid

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that the property value used to specify the size is not valid. This occurs if the size parameter is annotated using Valid=No.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6530.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ms.workload:
warning 6530: unrecognized format string style \<name>

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).

This warning indicates that the FormatString property is using a value other than scanf or printf. To correct this warning, review your code and use a valid value for the Style property.

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/c6551.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ ms.workload:
warning C6551: Invalid size specification: expression not parsable

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
2 changes: 1 addition & 1 deletion docs/code-quality/c6552.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ ms.workload:
warning C6552: Invalid `Deref=` or `Notref=`: expression not parsable

> [!NOTE]
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
> This warning occurs only in code that is using a deprecated version of the source-code annotation language (SAL). We recommend that you port your code to use the latest version of SAL. For more information, see [Using SAL Annotations to Reduce C/C++ Code Defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md).
2 changes: 1 addition & 1 deletion docs/code-quality/ca1045-do-not-pass-types-by-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ ms.workload:
Although return values are commonplace and heavily used, the correct application of `out` and `ref` parameters requires intermediate design and coding skills. Library architects who design for a general audience should not expect users to master working with `out` or `ref` parameters.

> [!NOTE]
> When you work with parameters that are large structures, the additional resources that are required to copy these structures could cause a performance effect when you pass by value. In these cases, you might consider using `ref` or `out` parameters.
> When you work with parameters that are large structures, the additional resources that are required to copy these structures could cause a performance effect when you pass by value. In these cases, you might consider using `ref` or `out` parameters.

## How to fix violations
To fix a violation of this rule that is caused by a value type, have the method return the object as its return value. If the method must return multiple values, redesign it to return a single instance of an object that holds the values.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ms.workload:
To fix a violation of this rule, remove the default constructor or make it private.

> [!NOTE]
> Some compilers automatically create a public default constructor if the type does not define any constructors. If this is the case with your type, add a private default constructor to eliminate the violation.
> Some compilers automatically create a public default constructor if the type does not define any constructors. If this is the case with your type, add a private default constructor to eliminate the violation.

## When to suppress warnings
Do not suppress a warning from this rule. The presence of the constructor suggests that the type is not a static type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can provide hints to the code analysis tool for C/C++ code that will help th
The code analysis tool assumes that the condition represented by the expression is true at the point where the function appears and remains true until expression is altered, for example, by assignment to a variable.

> [!NOTE]
> `_Analysis_assume` does not impact code optimization. Outside the code analysis tool, `_Analysis_assume` is defined as a no-op.
> `_Analysis_assume` does not impact code optimization. Outside the code analysis tool, `_Analysis_assume` is defined as a no-op.

## Example
The following code uses `_Analysis_assume` to correct the code analysis warning [C6388](../code-quality/c6388.md):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Managed code compilers often generate code that is added to a project to facilit
The **Suppress results from generated code** check box on the Code Analysis property page of a project enables you to select whether you want to see Code Analysis warnings from code generated by a third-party tool.

> [!NOTE]
> This option does not suppress Code Analysis errors and warnings from generated code when the errors and warnings appear in forms and templates. You can both view and maintain the source code for a form or a template.
> This option does not suppress Code Analysis errors and warnings from generated code when the errors and warnings appear in forms and templates. You can both view and maintain the source code for a form or a template.

### To suppress warnings for generated code in a project

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ Visual Studio Tools for Unity change log.
- Fix handling of parts of Visual Studio themes.

> [!IMPORTANT]
> C# being the predominant language in the Unity ecosystem - the new Sample Assets are in C#, the Unity documentation will default to C# - we removed our basic support for UnityScript and Boo to better focus on the C# experience. As a result, VSTU solutions are now C# only and are much faster to load.
> C# being the predominant language in the Unity ecosystem - the new Sample Assets are in C#, the Unity documentation will default to C# - we removed our basic support for UnityScript and Boo to better focus on the C# experience. As a result, VSTU solutions are now C# only and are much faster to load.

## 1.8.2.0
Released January 7, 2014
Expand Down Expand Up @@ -1408,7 +1408,7 @@ Visual Studio Tools for Unity change log.
- Fixed the translation of .pdb symbols on Unity 4.

> [!IMPORTANT]
> Because of the Visual Studio 2012 support, we had to rename a few files and move some other around. The UnityVS package to import Unity is now named either UnityVS 2010 or UnityVS 2012, for respectively Visual Studio 2010 and Visual Studio 2012. This version also requires that the UnityVS project files are regenerated.
> Because of the Visual Studio 2012 support, we had to rename a few files and move some other around. The UnityVS package to import Unity is now named either UnityVS 2010 or UnityVS 2012, for respectively Visual Studio 2010 and Visual Studio 2012. This version also requires that the UnityVS project files are regenerated.

## 1.0.6.0 - Internal build
Released September 12, 2012
Expand Down
Loading