Update doc for CA1716 to mention configurability of symbol kinds #5009
Conversation
|
@Evangelink : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
docs/code-quality/ca1716.md
Outdated
| @@ -52,10 +52,20 @@ You can suppress a warning from this rule if you're convinced that the identifie | |||
|
|
|||
| ## Configurability | |||
|
|
|||
| ### Analyzed types and members surface | |||
There was a problem hiding this comment.
Let's be consistent with the heading: https://docs.microsoft.com/en-us/visualstudio/code-quality/ca1802?view=vs-2019#api-surface
| ### Analyzed types and members surface | |
| ### Api Surface |
| 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: | ||
|
|
||
| ```ini | ||
| dotnet_code_quality.ca1716.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). | ||
|
|
||
| ### Analyzed symbol kinds |
There was a problem hiding this comment.
Please add a small sentence about configurability of analyzed symbol kinds at the end of the Cause section.
|
Hi @Evangelink - Could you make the revisions that @mavasani requests? Then we can merge the PR. Thanks. |
|
@Evangelink : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
Co-Authored-By: Manish Vasani <mavasani@microsoft.com>
|
@Evangelink : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
|
#sign-off |
|
@Jak-MS : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
Fix #4982
This new feature is not yet publicly released. Please sync-up with @mavasani for when to merge this PR.