Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 fromWarning
toInfo
(default is Hidden).It should be
Info
because 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