Ignore InternalsVisibleTo attribute section sample does not show the rule ID

[siewers]

Type of issue

Typo

Description

The section "Ignore InternalsVisibleTo attribute" section shows an example with a missing rule ID:

dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true

But it should be:

dotnet_code_quality.CA1852.ignore_internalsvisibleto = true

Page URL

https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1852

Content source URL

https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules/ca1852.md

Document Version Independent Id

8096f4f0-36fe-92d7-c4e8-b761f2197010

Article author

@gewarren

Metadata

• ID: 94bd55fe-ca92-f1c4-c1ac-6f1cffeac722
• Service: dotnet-fundamentals

Related Issues

[BartoszKlonowski]

@gewarren I don't think this is incorrect. This section is included in two rules: CA1852 and CA1812. So having CAXXXX makes this section "generic" for both.
If we would to "fix" this issue, we would show
dotnet_code_quality.CA1852.ignore_internalsvisibleto = true
in the page of CA1812, which would lead to another issue opened.

[siewers]

How am I supposed to know the documentation section is generic? It makes no sense to me that this section shows XXX when it's displayed on a specific rule. I honestly thought I was supposed to use XXX as the rule ID to begin with until I realized it didn't work and I had to specify the rule ID, although the docs didn't specify it.

If this really is so valuable to keep generic, then at least write so and mention that XXX should be replaced with the actual rule ID the article is for.

[BartoszKlonowski]

Sure, @siewers! I totally get your point 👍
Let me launch a PR for that and we will see what is the feedback.