Skip to content

Fix git push error for protected CLA branch #5615

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 10 commits into from
Jul 22, 2020
Merged
13 changes: 8 additions & 5 deletions docs/code-quality/ca1711.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ The following table lists the reserved suffixes and the base types and interface
|EventArgs|<xref:System.EventArgs?displayProperty=fullName>|
|EventHandler|An event-handler delegate|
|Exception|<xref:System.Exception?displayProperty=fullName>|
|Flag | Flags|<xref:System.Enum?displayProperty=fullName>|
|Flag|<xref:System.Enum?displayProperty=fullName>|
|Flags|<xref:System.Enum?displayProperty=fullName>|
|Permission|<xref:System.Security.IPermission?displayProperty=fullName>|
|Queue|<xref:System.Collections.Queue?displayProperty=fullName>|
|Stack|<xref:System.Collections.Stack?displayProperty=fullName>|
Expand Down Expand Up @@ -71,20 +72,22 @@ Do not suppress a warning from this rule unless the suffix has an unambiguous me

## Configurability

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:
If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), this rule is configurable.

You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1711.api_surface = private, internal
```

You can configure this option for just this rule, for all rules, or for all rules in this category (Naming). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).

If you're running this rule from [FxCop analyzers](install-fxcop-analyzers.md) (and not with legacy analysis), you can configure a list of allowed suffixes, with each suffix separated by the pipe character ("|"). For example, to specify that the rule should not run against Flag and Flags suffixes, add the following key-value pair to an .editorconfig file in your project:
You can configure a list of allowed suffixes, with each suffix separated by the pipe character ("|"). For example, to specify that the rule should not run against Flag and Flags suffixes, add the following key-value pair to an .editorconfig file in your project:

```ini
dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags
```

You can configure these options for just this rule, for all rules, or for all rules in this category (Naming). For more information, see [Configure FxCop analyzers](configure-fxcop-analyzers.md).

## Related rules

- [CA1710: Identifiers should have correct suffix](../code-quality/ca1710.md)
Expand Down
5 changes: 3 additions & 2 deletions docs/ide/not-in-toc/default.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Default page for F1 help
ms.date: 02/28/2018
ms.date: 07/20/2020
ms.topic: troubleshooting
robots: noindex,nofollow
f1_keywords:
Expand All @@ -16,11 +16,12 @@ It looks like we couldn't find what you were looking for, and we apologize. You

## Cursor position

If you're looking for F1 help on a keyword or API name, be sure the cursor is positioned inside or just to the right of the word before pressing **F1**. If that still doesn't work, select from the [useful links](#useful-links) list, or do a search on https://docs.microsoft.com.
If you're looking for F1 help on a keyword or API name, be sure you position the cursor inside or just to the right of the word before you press **F1**. If that still doesn't work, select from the following [useful links](#useful-links) list, or do a search on https://docs.microsoft.com.

## Useful links

- Search for reference documentation on [.NET API browser](/dotnet/api/).
- Browse a list of Knowledge Base articles on the [Visual Studio troubleshooting](/troubleshoot/visualstudio/welcome-visual-studio/) page.
- For C# help, see the [C# guide](/dotnet/csharp/index).
- For Visual Basic help, see the [Visual Basic guide](/dotnet/visual-basic/).
- For F# help, see the [F# guide](/dotnet/fsharp/).
Expand Down
2 changes: 1 addition & 1 deletion docs/windows/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,4 @@ additionalContent:
url: /cpp/linux/
- text: .NET Core cross-platform development
url: /dotnet/core/
footer: "[Blogs](https://devblogs.microsoft.com/visualstudio/) - [Twitter](https://twitter.com/VisualStudio) - [Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio) - [Issue Reporting](../ide/talk-to-us.md) - [Developer Community](https://developercommunity.visualstudio.com/spaces/8/index.html)"
footer: "[Blogs](https://devblogs.microsoft.com/visualstudio/) - [Twitter](https://twitter.com/VisualStudio) - [Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio) - [Issue Reporting](../ide/talk-to-us.md) - [Developer Community](https://developercommunity.visualstudio.com/spaces/8/index.html) - [Troubleshooting](/troubleshoot/visualstudio/welcome-visual-studio)"