Set CA1200 severity to info#48612
Set CA1200 severity to info#48612danmoseley merged 1 commit intodotnet:masterfrom carlossanlop:CA1200
Conversation
|
I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label. |
|
Tagging subscribers to this area: @ViktorHofer Issue DetailsWe are working on making triple slash comments the source of truth for documentation, instead of MS Docs. To achieve this, we are backporting MS Docs documentation to source code. In MS Docs, we have the ability to have In triple slash, we don't yet have the ability to point to groups of method overloads. There's a csharplang issue tracking this. The workaround is to prefix the DocID with It should be Here is a docs backporting PR that has to deal with that problem: #48137
|
danmoseley
left a comment
There was a problem hiding this comment.
I see you have posted in the csharplang repo. @jaredpar, do you have an idea of the cost of that item? it would be helpful to our efforts here.
We are working on making triple slash comments the source of truth for documentation, instead of MS Docs. To achieve this, we are backporting MS Docs documentation to source code.
In MS Docs, we have the ability to have
<see cref="Namespace.MethodGroupName()"/>items to point to groups of method overloads by either removing the parenthesis part, or adding the suffix%2A, or by preceding the API DocID withO:.In triple slash, we don't yet have the ability to point to groups of method overloads. There's a csharplang issue tracking this.
The workaround is to prefix the DocID with
O:, but to avoid a build failure, we need to change the severity of the CA1200 Roslyn analyzers fromWarningtoInfo(default is Hidden).It should be
Infobecause we still want people to tell people to avoid using prefixes, unless they are usingO:.Here is a docs backporting PR that has to deal with that problem: #48137