Skip to content

fix: MD019/no-multiple-space-atx #3102

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
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 @@ -10,7 +10,6 @@
"MD009": false,
"MD011": false,
"MD013": false,
"MD019": false,
"MD020": false,
"MD022": false,
"MD024": false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [Dictionary/Acronyms/CasingExceptions/Acronym](../code-quality/how-to-customize-the-code-analysis-dictionary.md#BKMK_DictionaryAcronymsCasingExceptionsAcronym)

### <a name="BKMK_DictionaryWordsRecognizedWord"></a> Dictionary/Words/Recognized/Word
### <a name="BKMK_DictionaryWordsRecognizedWord"></a> Dictionary/Words/Recognized/Word
To include a term in the list of terms that code analysis identifies as correctly spelled, add the term as the inner text of a Dictionary/Words/Recognized/Word element. Terms in Dictionary/Words/Recognized/Word elements are not case-sensitive.

**Example**
Expand Down Expand Up @@ -99,7 +99,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [CA2204: Literals should be spelled correctly](../code-quality/ca2204-literals-should-be-spelled-correctly.md)

### <a name="BKMK_DictionaryWordsUnrecognizedWord"></a> Dictionary/Words/Unrecognized/Word
### <a name="BKMK_DictionaryWordsUnrecognizedWord"></a> Dictionary/Words/Unrecognized/Word
To exclude a term from the list of terms that code analysis identifies as correctly spelled, add the term to exclude as the inner text of a Dictionary/Words/Unrecognized/Word element. Terms in Dictionary/Words/Unrecognized/Word elements are not case-sensitive.

**Example**
Expand Down Expand Up @@ -133,7 +133,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [CA2204: Literals should be spelled correctly](../code-quality/ca2204-literals-should-be-spelled-correctly.md)

### <a name="BKMK_DictionaryWordsDeprecatedTermPreferredAlternate"></a> Dictionary/Words/Deprecated/Term[@PreferredAlternate]
### <a name="BKMK_DictionaryWordsDeprecatedTermPreferredAlternate"></a> Dictionary/Words/Deprecated/Term[@PreferredAlternate]
To include a term in the list of terms that code analysis identifies as deprecated, add the term as the inner text of a Dictionary/Words/Deprecated/Term element. A deprecated term is a word that is spelled correctly but should not be used.

To include a suggested alternate term in the warning, specify the alternate in the PreferredAlternate attribute of the Term element. You can leave the attribute value empty if you do not want to suggest an alternate.
Expand Down Expand Up @@ -169,7 +169,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [CA1726: Use preferred terms](../code-quality/ca1726-use-preferred-terms.md)

### <a name="BKMK_DictionaryWordsCompoundTermCompoundAlternate"></a> Dictionary/Words/Compound/Term[@CompoundAlternate]
### <a name="BKMK_DictionaryWordsCompoundTermCompoundAlternate"></a> Dictionary/Words/Compound/Term[@CompoundAlternate]
The built-in dictionary identifies some terms as single, discrete terms rather than a compound term. To include a term in the list of terms that code analysis identifies as a compound word and to specify the correct casing of the term, add the term as the inner text of a Dictionary/Words/Compound/Term element. In the CompoundAlternate attribute of the Term element, specify the individual words that make up the compound term by capitalizing the first letter of the individual words (Pascal case). Note that the term specified in the inner text is automatically added to the Dictionary/Words/DiscreteExceptions list.

- The deprecated term in Dictionary/Words/ Deprecated/Term element is not case-sensitive.
Expand Down Expand Up @@ -201,7 +201,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [CA1704: Identifiers should be spelled correctly](../code-quality/ca1704-identifiers-should-be-spelled-correctly.md)

### <a name="BKMK_DictionaryWordsDiscreteExceptionsTerm"></a> Dictionary/Words/DiscreteExceptions/Term
### <a name="BKMK_DictionaryWordsDiscreteExceptionsTerm"></a> Dictionary/Words/DiscreteExceptions/Term
To exclude a term in the list of terms that code analysis identifies as a single, discrete word when the term is checked by the casing rules for compound words, add the term as the inner text of a Dictionary/Words/DiscreteExceptions/Term element. The term in Dictionary/Words/DiscreteExceptions/Term element is not case-sensitive.

**Example**
Expand All @@ -225,7 +225,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [CA1702: Compound words should be cased correctly](../code-quality/ca1702-compound-words-should-be-cased-correctly.md)

### <a name="BKMK_DictionaryAcronymsCasingExceptionsAcronym"></a> Dictionary/Acronyms/CasingExceptions/Acronym
### <a name="BKMK_DictionaryAcronymsCasingExceptionsAcronym"></a> Dictionary/Acronyms/CasingExceptions/Acronym
To include an acronym in the list of terms that code analysis identifies as correctly spelled and to indicate how the acronym when the term is checked by the casing rules for compound words, add the term as the inner text of a Dictionary/Acronyms/CasingExceptions/Acronym element. The acronym in the Dictionary/Acronyms/CasingExceptions/Acronym element is case-sensitive.

**Example**
Expand All @@ -247,7 +247,7 @@ Code Analysis uses a built-in dictionary to check identifiers in your code for e

- [CA1709: Identifiers should be cased correctly](../code-quality/ca1709-identifiers-should-be-cased-correctly.md)

## <a name="BKMK_ToApplyACustomDictionaryToAProject"></a> To apply a custom dictionary to a project
## <a name="BKMK_ToApplyACustomDictionaryToAProject"></a> To apply a custom dictionary to a project

1. In **Solution Explorer**, use one of the following procedures:

Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/troubleshooting-code-analysis-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This topic contains troubleshooting information for the following Visual Studio

- [Changes in a Visual Studio 2010 Rule Set Are Not Reflected in Previous Visual Studio Versions](#ChildRuleSetChangesInPreviousVersions)

## <a name="ChildRuleSetChangesInPreviousVersions"></a> Changes in a Visual Studio 2010 Rule Set Are Not Reflected in Previous Visual Studio Versions
## <a name="ChildRuleSetChangesInPreviousVersions"></a> Changes in a Visual Studio 2010 Rule Set Are Not Reflected in Previous Visual Studio Versions
When you create a rule set in [!INCLUDE[vs_dev10_long](../code-quality/includes/vs_dev10_long_md.md)] that contains a child rule set, a change to the child rule set might not be applied in code analysis runs on computers that use an earlier version of Visual Studio. To resolve this issue, you must force a rewrite of the parent rule set, that is the rule set that contains the child rule set.

1. Open the parent rule set in [!INCLUDE[vs_dev10_long](../code-quality/includes/vs_dev10_long_md.md)].
Expand Down
2 changes: 1 addition & 1 deletion docs/code-quality/troubleshooting-code-metrics-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You might encounter some of the following issues when you collect code metrics:

- [Changes in Visual Studio 2010 code complexity calculations](#Changes_in_Visual_Studio_2010_code_complexity_calculations)

## <a name="Changes_in_Visual_Studio_2010_code_complexity_calculations"></a> Changes in Visual Studio 2010 code complexity calculations
## <a name="Changes_in_Visual_Studio_2010_code_complexity_calculations"></a> Changes in Visual Studio 2010 code complexity calculations
For the same function, the code complexity metric calculated in [!INCLUDE[vs_dev10_long](../code-quality/includes/vs_dev10_long_md.md)] can be different from the metric calculated by earlier versions of [!INCLUDE[vs_current_short](../code-quality/includes/vs_current_short_md.md)] for the following situations:

- The function contains one or more catch blocks. In previous versions of [!INCLUDE[vs_current_short](../code-quality/includes/vs_current_short_md.md)], catch blocks were not included in the calculation. In [!INCLUDE[vs_dev10_long](../code-quality/includes/vs_dev10_long_md.md)], the complexity of each catch block is added to the complexity of the function.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ With Visual Studio Tools for Xamarin, you can target Android, iOS, and Windows i
|[Learn about Universal Windows apps in Visual Studio](https://visualstudio.microsoft.com/vs/universal-windows-platform/) (VisualStudio.com)|
|[Learn about the similarities between Swift and C#](https://aka.ms/scposter) (download.microsoft.com)|

### <a name="AndroidHTML"></a> Target Android, iOS, and Windows from a single code base
### <a name="AndroidHTML"></a> Target Android, iOS, and Windows from a single code base

You can build native apps for Android, iOS, and Windows by using C# or F# (Visual Basic is not supported at this time). To get started, install Visual Studio 2017, select the **Mobile Development with .NET** option in the installer.

Expand All @@ -50,7 +50,7 @@ With Visual Studio Tools for Xamarin, you can target Android, iOS, and Windows i

Depending on the complexity of your apps design, you might consider building it by using *Xamarin.Forms* templates in the **Mobile Apps** group of project templates. Xamarin.Forms is a UI toolkit that lets you create a single interface that you can share across Android, iOS, and Windows. When you compile a Xamarin.Forms solution, you'll get an Android app, an iOS app, and a Windows app. For more details, see [Learn about mobile development with Xamarin](/xamarin/cross-platform/get-started/introduction-to-mobile-development/) and the [Xamarin.Forms documentation](/xamarin/xamarin-forms/).

#### <a name="ShareHTML"></a> Share code between Android, iOS, and Windows apps
#### <a name="ShareHTML"></a> Share code between Android, iOS, and Windows apps

If you're not using Xamarin.Forms and choose to design for each platform individually, you can share most of your non-UI code between platform projects (Android, iOS, and Windows). This includes any business logic, cloud integration, database access, or any other code that targets the .NET Framework. The only code that you can't share is code that targets a specific platform.

Expand All @@ -63,7 +63,7 @@ With Visual Studio Tools for Xamarin, you can target Android, iOS, and Windows i
|[Sharing Code Options](/xamarin/cross-platform/app-fundamentals/code-sharing/) (Xamarin) |
|[Code sharing options with .NET](/dotnet/standard/cross-platform/) |

### <a name="WindowsHTML"></a> Target Windows 10 devices
### <a name="WindowsHTML"></a> Target Windows 10 devices

![Windows Devices](../cross-platform/media/windowsdevices.png "Windows Devices")

Expand All @@ -78,7 +78,7 @@ With Visual Studio Tools for Xamarin, you can target Android, iOS, and Windows i
|[Develop apps for the Universal Windows Platform (UWP)](../cross-platform/develop-apps-for-the-universal-windows-platform-uwp.md)|
|[Migrate apps to the Universal Windows Platform (UWP)](https://msdn.microsoft.com/library/mt148501.aspx)|

## <a name="HTML"></a> Build an app for Android, iOS, and Windows (HTML/JavaScript)
## <a name="HTML"></a> Build an app for Android, iOS, and Windows (HTML/JavaScript)

![Windows, iOS, and Android devices](../cross-platform/media/homedevices.png "Windows, iOS, and Android devices")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ To install and use the remote agent to develop code for iOS, you must first have

`sudo npm install -g npm@latest`

## <a name="Install"></a> Install the remote agent for iOS
## <a name="Install"></a> Install the remote agent for iOS

When you install Visual C++ for Cross-Platform Mobile Development, Visual Studio can communicate with [vcremote](https://go.microsoft.com/fwlink/p/?LinkId=534988), a remote agent running on your Mac to transfer files, build and run your iOS app, and send debugging commands.

Before you install the remote agent, make sure you have satisfied the [Prerequisites](#prerequisites) and installed [Visual C++ for cross-platform mobile development](../cross-platform/install-visual-cpp-for-cross-platform-mobile-development.md#install-the-tools).

### <a name="DownloadInstall"></a> To download and install the remote agent
### <a name="DownloadInstall"></a> To download and install the remote agent

- From the Terminal app on your Mac, enter:

Expand All @@ -81,11 +81,11 @@ Before you install the remote agent, make sure you have satisfied the [Prerequis

If you update to a new version of Visual Studio, you must update to the current version of the remote agent as well. To update the remote agent, repeat the steps to download and install the remote agent.

## <a name="Start"></a> Start the remote agent
## <a name="Start"></a> Start the remote agent

The remote agent must be running for Visual Studio to build and run your iOS code. Visual Studio must be paired with the remote agent before it can communicate. By default, the remote agent runs in secured connection mode, which requires a PIN to pair with Visual Studio.

### <a name="RemoteAgentStartServer"></a> To start the remote agent
### <a name="RemoteAgentStartServer"></a> To start the remote agent

- From the Terminal app on your Mac, enter:

Expand Down Expand Up @@ -121,7 +121,7 @@ Once you have started the remote agent, you can use it from Visual Studio until

- In the Terminal window vcremote is running in, enter **Control**+**C**.

## <a name="ConfigureVS"></a> Configure the remote agent in Visual Studio
## <a name="ConfigureVS"></a> Configure the remote agent in Visual Studio

To connect to the remote agent from Visual Studio, you must specify the remote configuration in the Visual Studio options.

Expand Down Expand Up @@ -158,7 +158,7 @@ To connect to the remote agent from Visual Studio, you must specify the remote c

Visual Studio uses the same information to connect to the remote agent on your Mac each time you use it. You do not need to pair Visual Studio with the remote agent again unless you generate a new security certificate on your Mac, or its hostname or IP address changes.

## <a name="GeneratePIN"></a> Generate a new security PIN
## <a name="GeneratePIN"></a> Generate a new security PIN

When you start the remote agent the first time, the generated PIN is valid for a limited amount of time—by default, 10 minutes. If you don't pair Visual Studio to the remote agent before the time expires, you will need to generate a new PIN.

Expand All @@ -172,7 +172,7 @@ When you start the remote agent the first time, the generated PIN is valid for a

The remote agent generates a new temporary PIN. To pair Visual Studio by using the new PIN, repeat the steps in [Configure the remote agent in Visual Studio](#ConfigureVS).

## <a name="GenerateCert"></a> Generate a new server certificate
## <a name="GenerateCert"></a> Generate a new server certificate

For security purposes, the server certificates that pair Visual Studio with the remote agent are tied to the IP address or host name of your Mac. If these values change, you must generate a new server certificate, and then reconfigure Visual Studio with the new values.

Expand All @@ -194,7 +194,7 @@ For security purposes, the server certificates that pair Visual Studio with the

1. To pair Visual Studio by using the new PIN, repeat the steps in [Configure the remote agent in Visual Studio](#ConfigureVS).

## <a name="ConfigureMac"></a> Configure the remote agent on the Mac
## <a name="ConfigureMac"></a> Configure the remote agent on the Mac

You can configure the remote agent using various command line options. For example, you can specify the port to listen for build requests and specify the maximum number of builds to maintain on the file system. By default, the limit is 10 builds. The remote agent will remove builds that exceed the maximum on shutdown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The setup program tries to configure these prerequisites for you silently when y
> [!IMPORTANT]
> The setup program for the emulator checks the prerequisites for running Visual Studio Emulator for Android. It displays warnings if the prerequisites are not present, but it does not require them.

## <a name="Checklist"></a> Quick checklist
## <a name="Checklist"></a> Quick checklist

Here is a quick checklist of the requirements for running the Visual Studio Emulator for Android. For more detailed info, see the subsequent sections in this topic.

Expand Down
Loading