Skip to content

Commit 08fabbd

Browse files
authored
Merge pull request #3113 from nschonni/fix--MD005/list-indent
fix: MD005/list-indent
2 parents 89ec5e6 + 2d84f2d commit 08fabbd

33 files changed

+330
-309
lines changed

.markdownlint.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
"MD001": false,
44
"MD002": false,
55
"MD004": false,
6-
"MD005": false,
7-
"MD006": false,
86
"MD007": false,
97
"MD009": false,
108
"MD011": false,

docs/code-quality/ca2300-do-not-use-insecure-deserializer-binaryformatter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ This rule finds <xref:System.Runtime.Serialization.Formatters.Binary.BinaryForma
4141
- Protocol Buffers
4242
- Make the serialized data tamper-proof. After serialization, cryptographically sign the serialized data. Before deserialization, validate the cryptographic signature. Protect the cryptographic key from being disclosed, and design for key rotations.
4343
- Restrict deserialized types. Implement a custom <xref:System.Runtime.Serialization.SerializationBinder?displayProperty=nameWithType>. Before deserializing with <xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter>, set the <xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter.Binder> property to an instance of your custom <xref:System.Runtime.Serialization.SerializationBinder>. In the overridden <xref:System.Runtime.Serialization.SerializationBinder.BindToType%2A> method, if the type is unexpected then throw an exception.
44-
- If you restrict deserialized types, you may want to disable this rule and enable rules [CA2301](ca2301-do-not-call-binaryformatter-deserialize-without-first-setting-binaryformatter-binder.md) and [CA2302](ca2302-ensure-binaryformatter-binder-is-set-before-calling-binaryformatter-deserialize.md). Rules [CA2301](ca2301-do-not-call-binaryformatter-deserialize-without-first-setting-binaryformatter-binder.md) and [CA2302](ca2302-ensure-binaryformatter-binder-is-set-before-calling-binaryformatter-deserialize.md) help to ensure that the <xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter.Binder> property is always set before deserializing.
44+
- If you restrict deserialized types, you may want to disable this rule and enable rules [CA2301](ca2301-do-not-call-binaryformatter-deserialize-without-first-setting-binaryformatter-binder.md) and [CA2302](ca2302-ensure-binaryformatter-binder-is-set-before-calling-binaryformatter-deserialize.md). Rules [CA2301](ca2301-do-not-call-binaryformatter-deserialize-without-first-setting-binaryformatter-binder.md) and [CA2302](ca2302-ensure-binaryformatter-binder-is-set-before-calling-binaryformatter-deserialize.md) help to ensure that the <xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter.Binder> property is always set before deserializing.
4545

4646
## When to suppress warnings
4747

docs/code-quality/cpp-core-guidelines-warnings.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,17 +78,17 @@ The C++ Core Guidelines are there to help you write better and safer code. Howev
7878

7979
As new rules are added to the C++ Core Guidelines Checker, the number of warnings that are produced for pre-existing code may increase. You can use predefined rule sets to filter which kinds of rules to enable. As of Visual Studio 2017 version 15.3, the supported rule sets are:
8080

81-
- **Owner Pointer Rules** enforce [resource-management checks related to owner\<T> from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#r-resource-management).
81+
- **Owner Pointer Rules** enforce [resource-management checks related to owner\<T> from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#r-resource-management).
8282

83-
- **Const Rules** enforce [const-related checks from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#con-constants-and-immutability).
83+
- **Const Rules** enforce [const-related checks from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#con-constants-and-immutability).
8484

85-
- **Raw Pointer Rules** enforce [resource-management checks related to raw pointers from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#r-resource-management).
85+
- **Raw Pointer Rules** enforce [resource-management checks related to raw pointers from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#r-resource-management).
8686

87-
- **Unique Pointer Rules** enforce [resource-management checks related to types with unique pointer semantics from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#r-resource-management).
87+
- **Unique Pointer Rules** enforce [resource-management checks related to types with unique pointer semantics from the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#r-resource-management).
8888

89-
- **Bounds Rules** enforce the [Bounds profile of the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#probounds-bounds-safety-profile).
89+
- **Bounds Rules** enforce the [Bounds profile of the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#probounds-bounds-safety-profile).
9090

91-
- **Type Rules** enforce the [Type profile of the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#prosafety-type-safety-profile).
91+
- **Type Rules** enforce the [Type profile of the C++ Core Guidelines](http://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#prosafety-type-safety-profile).
9292

9393
You can choose to limit warnings to just one or a few of the groups. The **Native Minimum** and **Native Recommended** rule sets include C++ Core Check rules in addition to other PREfast checks. To see the available rule sets, open the Project Properties dialog, select **Code Analysis\General**, open the dropdown in the **Rule Sets** combo-box, and pick **Choose multiple rule sets**. For more information about using Rule Sets in Visual Studio, see [Using Rule Sets to Group Code Analysis Rules](using-rule-sets-to-group-code-analysis-rules.md).
9494

docs/debugger/autos-and-locals-windows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ Set a breakpoint and start debugging. When the breakpoint is hit, execution paus
7979

8080
## <a name="bkmk_whatvariables"></a> Variables in the Autos window (C#, C++, Visual Basic, Python)
8181

82-
Different code languages display different variables in the **Autos** window.
82+
Different code languages display different variables in the **Autos** window.
8383

84-
- In C# and Visual Basic, the **Autos** window displays any variable used on the current or preceding line. For example, in C# or Visual Basic code, declare the following four variables:
84+
- In C# and Visual Basic, the **Autos** window displays any variable used on the current or preceding line. For example, in C# or Visual Basic code, declare the following four variables:
8585

8686
```csharp
8787
public static void Main()
@@ -100,7 +100,7 @@ Set a breakpoint and start debugging. When the breakpoint is hit, execution paus
100100

101101
The value of `c` is 0, because the line `c = 3` has not yet been executed.
102102

103-
- In C++, the **Autos** window displays the variables used in at least three lines before the current line where execution is paused. For example, in C++ code, declare six variables:
103+
- In C++, the **Autos** window displays the variables used in at least three lines before the current line where execution is paused. For example, in C++ code, declare six variables:
104104

105105
```C++
106106
void main() {

docs/debugger/debug-using-the-just-in-time-debugger.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ To enable Just-In-Time debugging instead of standard Windows Form error handling
9090
For more information, see <xref:System.Diagnostics.DebuggableAttribute>.
9191

9292
## <a name="BKMK_Using_JIT"></a>Use Just-In-Time debugging
93-
This example walks you through Just-In-Time debugging when an app throws an error.
93+
This example walks you through Just-In-Time debugging when an app throws an error.
9494

95-
- You must have Visual Studio installed to follow these steps. If you don't have Visual Studio, you can download the free [Visual Studio Community Edition](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=15).
95+
- You must have Visual Studio installed to follow these steps. If you don't have Visual Studio, you can download the free [Visual Studio Community Edition](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=15).
9696

97-
- Make sure Just-In-Time debugging is [enabled](#BKMK_Enabling) in **Tools** > **Options** > **Debugging** > **Just-In-Time**.
97+
- Make sure Just-In-Time debugging is [enabled](#BKMK_Enabling) in **Tools** > **Options** > **Debugging** > **Just-In-Time**.
9898

9999
For this example, you'll make a C# console app in Visual Studio that throws a [NullReferenceException](/dotnet/api/system.nullreferenceexception).
100100

docs/debugger/historical-debugging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Historical debugging is a mode of debugging that depends on the information coll
2525

2626
## How do I start using historical debugging?
2727

28-
IntelliTrace is on by default. All you have to do is decide which events and function calls are of interest to you, and whether you want to view snapshots of your full application state. For more information about defining what you want to look for, see [IntelliTrace Features](../debugger/intellitrace-features.md). Feature support varies by language and app type.
28+
IntelliTrace is on by default. All you have to do is decide which events and function calls are of interest to you, and whether you want to view snapshots of your full application state. For more information about defining what you want to look for, see [IntelliTrace Features](../debugger/intellitrace-features.md). Feature support varies by language and app type.
2929

30-
- To view snapshots with historical debugging, see [Inspect previous app states using IntelliTrace](../debugger/view-historical-application-state.md)
31-
- To learn how to inspect variables and navigate code, see [Inspect your app with historical debugging](../debugger/historical-debugging-inspect-app.md)
32-
- To learn more about debugging with IntelliTrace events, see [Walkthrough: Using IntelliTrace](../debugger/walkthrough-using-intellitrace.md).
30+
- To view snapshots with historical debugging, see [Inspect previous app states using IntelliTrace](../debugger/view-historical-application-state.md)
31+
- To learn how to inspect variables and navigate code, see [Inspect your app with historical debugging](../debugger/historical-debugging-inspect-app.md)
32+
- To learn more about debugging with IntelliTrace events, see [Walkthrough: Using IntelliTrace](../debugger/walkthrough-using-intellitrace.md).

docs/debugger/run-windows-store-apps-in-the-simulator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,26 +45,26 @@ The Visual Studio simulator for UWP apps is a desktop application that simulates
4545

4646
- ![Simulator two finger target](../debugger/media/simulator_twofinger.png "SIMULATOR_TwoFinger")
4747

48-
The double target icon indicates the location of two fingers on the device screen.
48+
- The double target icon indicates the location of two fingers on the device screen.
4949

5050
- Move the mouse to position the icons over the object on the device screen.
5151

5252
- Rotate the mouse wheel backward or forward to change the simulated distance of the two fingers before you pinch or zoom.
5353

54-
- - ![Pinch, zoom, and rotate targets](../debugger/media/simulator_twofingerengaged.png "SIMULATOR_TwoFingerEngaged")
54+
- ![Pinch, zoom, and rotate targets](../debugger/media/simulator_twofingerengaged.png "SIMULATOR_TwoFingerEngaged")
5555

56-
Press the left button and rotate the wheel backward (towards you) to zoom in (pinch).
56+
- Press the left button and rotate the wheel backward (towards you) to zoom in (pinch).
5757

5858
- Press the left button and rotate the mouse wheel forward (away from you) to zoom out (zoom).
5959

6060
## Object rotation
6161
The **Touch emulation rotate** button sets the interaction mode to rotation gestures using two fingers.
6262

63-
- - Move the mouse to position the icons over the object on the device screen.
63+
- Move the mouse to position the icons over the object on the device screen.
6464

6565
- Rotate the mouse wheel backward or forward to change the simulated orientation of the two fingers before you rotate the object.
6666

67-
- - Press the left button and rotate the wheel backward (towards you) to rotate the object counter-clockwise. As you rotate the mouse wheel, one of the two target icons rotates around the other to indicate the relative size of the rotation.
67+
- Press the left button and rotate the wheel backward (towards you) to rotate the object counter-clockwise. As you rotate the mouse wheel, one of the two target icons rotates around the other to indicate the relative size of the rotation.
6868

6969
- Press the left button and rotate the mouse wheel forward (away from you) to rotate the object clockwise.
7070

docs/extensibility/ux-guidelines/ux-essentials-for-visual-studio.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,12 @@ ms.workload:
4747
## Screen resolution
4848

4949
### Minimum resolution
50-
- The minimum resolution for Visual Studio Dev14 is **1280x720**. This means that it is *possible* to use Visual Studio at this resolution, although it might not be an optimal user experience. There is no guarantee that all aspects will be usable at resolutions lower than 1280x720.
5150

52-
- The target resolution for Visual Studio is **1366x768**. This is the lowest resolution at which we promise a *good* user experience.
51+
- The minimum resolution for Visual Studio 2015 is **1280x720**. This means that it is *possible* to use Visual Studio at this resolution, although it might not be an optimal user experience. There is no guarantee that all aspects will be usable at resolutions lower than 1280x720.
5352

54-
- Initial dialog height should be **smaller than 700 pixels**, so it fits within the minimum resolution of the IDE frame at 96 dpi.
53+
- The target resolution for Visual Studio is **1366x768**. This is the lowest resolution at which we promise a *good* user experience.
54+
55+
- Initial dialog height should be **smaller than 700 pixels**, so it fits within the minimum resolution of the IDE frame at 96 dpi.
5556

5657
### High-density displays
5758
UI in Visual Studio must work well in all DPI scaling factors that Windows supports out of the box: 150%, 200%, and 250%.
@@ -157,4 +158,4 @@ Forcing the user to read explanatory text before dismissing UI is an anti-patter
157158

158159
**Bad:** "Click here for instructions about how to create a new project."
159160

160-
**Good:** "How do I create a new project?"
161+
**Good:** "How do I create a new project?"

docs/extensibility/walkthrough-publishing-a-visual-studio-extension.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,27 +74,27 @@ This article uses a default VSPackage extension, but the steps are valid for eve
7474

7575
* **VSIX ID** is the unique identifier that Visual Studio uses for your extension. This identifier is required if you would like to have your extension auto-updated. This identifier is auto-populated from the *source.extension.vsixmanifest* file.
7676

77-
* **Logo** that is used for your extension. This logo is auto-populated from the *source.extension.vsixmanifest* file if provided.
77+
* **Logo** that is used for your extension. This logo is auto-populated from the *source.extension.vsixmanifest* file if provided.
7878

79-
* **Short description** of what your extension does. This description is auto-populated from the *source.extension.vsixmanifest* file.
79+
* **Short description** of what your extension does. This description is auto-populated from the *source.extension.vsixmanifest* file.
8080

81-
* **Overview** is a good place to include screenshots and detailed information about what your extension does.
81+
* **Overview** is a good place to include screenshots and detailed information about what your extension does.
8282

83-
* **Supported Visual Studio versions** lets you choose which versions of Visual Studio your extension will work on. Your extension is only installed to those versions.
83+
* **Supported Visual Studio versions** lets you choose which versions of Visual Studio your extension will work on. Your extension is only installed to those versions.
8484

85-
* **Supported Visual Studio edition lets you choose which editions of Visual Studio your extension will work on. Your extension is only installed to those editions.
85+
* **Supported Visual Studio edition lets you choose which editions of Visual Studio your extension will work on. Your extension is only installed to those editions.
8686

87-
* **Type**. The most common type of extensions are **Tools**.
87+
* **Type**. The most common type of extensions are **Tools**.
8888

89-
* **Categories**. Pick up to three that are a best fit for your extension.
89+
* **Categories**. Pick up to three that are a best fit for your extension.
9090

91-
* **Tags** are keywords that help users find your extension. Tags can help increase the search relevance of your extensions in the Marketplace.
91+
* **Tags** are keywords that help users find your extension. Tags can help increase the search relevance of your extensions in the Marketplace.
9292

93-
* **Pricing Category** is the cost of your extension.
93+
* **Pricing Category** is the cost of your extension.
9494

95-
* **Source code repository** allows you to share a link to your source code with the community.
95+
* **Source code repository** allows you to share a link to your source code with the community.
9696

97-
* **Allow Q&A for your extension** lets users leave questions on your extension entry page.
97+
* **Allow Q&A for your extension** lets users leave questions on your extension entry page.
9898

9999
9. Click **Save & Upload**. This option takes you back to your publisher manage page. Your extension has not yet been published. To publish your extension, right-click on your extension and select **Make Public**. You can view how your extension will look like on Marketplace by selecting **View Extension**. For acquisition numbers, click on **Reports**. To make changes to your extension, click on **Edit**.
100100

docs/ide/dotfuscator/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can install Dotfuscator Community from the Visual Studio IDE:
4343
1. In the **Search Box** (Ctrl+Q), type `dotfuscator`. <br/> <br/> ![Search Box](media/install_in_vs19_12.png) <br/> <br/>
4444

4545
2. In the search results shown, under the *Components* heading, select **Install PreEmptive Protection - Dotfuscator**.
46-
* If you instead see, under the *Menus* heading, **PreEmptive Protection - Dotfuscator Community**, then Dotfuscator Community is already installed. Select that option to [get started][get-started].
46+
* If you instead see, under the *Menus* heading, **PreEmptive Protection - Dotfuscator Community**, then Dotfuscator Community is already installed. Select that option to [get started][get-started].
4747

4848
3. A Visual Studio Installer window will launch, pre-configured to install Dotfuscator Community.
4949
> [!NOTE]

docs/ide/how-to-view-save-and-configure-build-log-files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ ms.workload:
1414

1515
After you build a project in the Visual Studio IDE, you can view information about that build in the **Output** window. By using this information, you can, for example, troubleshoot a build failure.
1616

17-
- For C++ projects, you can also view the same information in a *.txt* file that's created and saved automatically.
17+
- For C++ projects, you can also view the same information in a *.txt* file that's created and saved automatically.
18+
19+
- For managed code projects, you can click in the build output window and press **Ctrl**+**S**. Visual Studio prompts you for a location to save the information from the **Output** window into a *.txt* file.
1820

19-
- For managed code projects, you can click in the build output window and press **Ctrl**+**S**. Visual Studio prompts you for a location to save the information from the **Output** window into a *.txt* file.
20-
2121
You can also use the IDE to specify what kinds of information you want to view about each build.
2222

2323
If you build any kind of project by using MSBuild, you can create a *.txt* file to save information about the build. For more information, see [Obtain build logs](../msbuild/obtaining-build-logs-with-msbuild.md).

0 commit comments

Comments
 (0)