dotnet / dotnet/docs

The doc for CA1506 (and presumably related warnings) is succinct to the point of being hard to follow

Open
#32,905 0 comments 0 reactions 0 assignees View on GitHub
dotnet-fundamentals/svc
Dominant language
No language data
Stars
4.8k
Forks
6.1k
Avg merge
15h 21m
Merged PRs (30d)
370

Description

**Issue description**

A customer reported on the internal StackOverflow page that the doc page for CA1506 was inaccurate and useless. Having looked it over, I think its suggestions on how to suppress warnings seem accurate but are very succinct to the point where it is difficult for even an experienced software engineer to follow unless they work in developer tools. Furthermore, having links to other doc pages makes it harder to know what is important.

One additional way to suppress these warnings is adding `CA1506` to your MSBuild project or specifying it on the command line or in a Directory.Build.props, etc. That option was not mentioned in the doc page.

[This](https://stackoverflow.microsoft.com/questions/334729) is the StackOverflow post I referred to.

---
#### Document Details

⚠ *Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.*

* ID: d6bc7ccb-aab7-7e71-f5c5-82cd8fbef17f
* Version Independent ID: b5a70070-37a7-68ee-3ef4-969c961f4486
* Content: [CA1506: Avoid excessive class coupling (code analysis) - .NET](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1506)
* Content Source: [docs/fundamentals/code-analysis/quality-rules/ca1506.md](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules/ca1506.md)
* Product: **dotnet-fundamentals**
* GitHub Login: @gewarren
* Microsoft Alias: **gewarren**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.