Skip to content

fix: MD005/list-indent #3113

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
merged 4 commits into from
Apr 19, 2019
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
"MD001": false,
"MD002": false,
"MD004": false,
"MD005": false,
"MD006": false,
"MD007": false,
"MD009": false,
"MD011": false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This rule finds <xref:System.Runtime.Serialization.Formatters.Binary.BinaryForma
- Protocol Buffers
- 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.
- 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.
- 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.
- 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.

## When to suppress warnings

Expand Down
12 changes: 6 additions & 6 deletions docs/code-quality/cpp-core-guidelines-warnings.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,17 @@ The C++ Core Guidelines are there to help you write better and safer code. Howev

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:

- **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).
- **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).

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

- **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).
- **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).

- **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).
- **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).

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

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

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).

Expand Down
6 changes: 3 additions & 3 deletions docs/debugger/autos-and-locals-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ Set a breakpoint and start debugging. When the breakpoint is hit, execution paus

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

Different code languages display different variables in the **Autos** window.
Different code languages display different variables in the **Autos** window.

- 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:
- 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:

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

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

- 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:
- 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:

```C++
void main() {
Expand Down
6 changes: 3 additions & 3 deletions docs/debugger/debug-using-the-just-in-time-debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ To enable Just-In-Time debugging instead of standard Windows Form error handling
For more information, see <xref:System.Diagnostics.DebuggableAttribute>.

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

- 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).
- 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).

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

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

Expand Down
8 changes: 4 additions & 4 deletions docs/debugger/historical-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Historical debugging is a mode of debugging that depends on the information coll

## How do I start using historical debugging?

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.
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.

- To view snapshots with historical debugging, see [Inspect previous app states using IntelliTrace](../debugger/view-historical-application-state.md)
- To learn how to inspect variables and navigate code, see [Inspect your app with historical debugging](../debugger/historical-debugging-inspect-app.md)
- To learn more about debugging with IntelliTrace events, see [Walkthrough: Using IntelliTrace](../debugger/walkthrough-using-intellitrace.md).
- To view snapshots with historical debugging, see [Inspect previous app states using IntelliTrace](../debugger/view-historical-application-state.md)
- To learn how to inspect variables and navigate code, see [Inspect your app with historical debugging](../debugger/historical-debugging-inspect-app.md)
- To learn more about debugging with IntelliTrace events, see [Walkthrough: Using IntelliTrace](../debugger/walkthrough-using-intellitrace.md).
10 changes: 5 additions & 5 deletions docs/debugger/run-windows-store-apps-in-the-simulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,26 +45,26 @@ The Visual Studio simulator for UWP apps is a desktop application that simulates

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

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

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

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

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

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

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

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

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

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

- - 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.
- 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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@ ms.workload:
## Screen resolution

### Minimum resolution
- 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.

- The target resolution for Visual Studio is **1366x768**. This is the lowest resolution at which we promise a *good* user experience.
- 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.

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

- Initial dialog height should be **smaller than 700 pixels**, so it fits within the minimum resolution of the IDE frame at 96 dpi.

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

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

**Good:** "How do I create a new project?"
**Good:** "How do I create a new project?"
Original file line number Diff line number Diff line change
Expand Up @@ -74,27 +74,27 @@ This article uses a default VSPackage extension, but the steps are valid for eve

* **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.

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

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

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

* **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.
* **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.

* **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.
* **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.

* **Type**. The most common type of extensions are **Tools**.
* **Type**. The most common type of extensions are **Tools**.

* **Categories**. Pick up to three that are a best fit for your extension.
* **Categories**. Pick up to three that are a best fit for your extension.

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

* **Pricing Category** is the cost of your extension.
* **Pricing Category** is the cost of your extension.

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

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

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**.

Expand Down
2 changes: 1 addition & 1 deletion docs/ide/dotfuscator/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can install Dotfuscator Community from the Visual Studio IDE:
1. In the **Search Box** (Ctrl+Q), type `dotfuscator`. <br/> <br/> ![Search Box](media/install_in_vs19_12.png) <br/> <br/>

2. In the search results shown, under the *Components* heading, select **Install PreEmptive Protection - Dotfuscator**.
* 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].
* 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].

3. A Visual Studio Installer window will launch, pre-configured to install Dotfuscator Community.
> [!NOTE]
Expand Down
6 changes: 3 additions & 3 deletions docs/ide/how-to-view-save-and-configure-build-log-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ ms.workload:

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.

- For C++ projects, you can also view the same information in a *.txt* file that's created and saved automatically.
- For C++ projects, you can also view the same information in a *.txt* file that's created and saved automatically.

- 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.

- 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.

You can also use the IDE to specify what kinds of information you want to view about each build.

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).
Expand Down
Loading