Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set CA1200 severity to info #48612

Merged
merged 1 commit into from
Feb 23, 2021
Merged

Set CA1200 severity to info #48612

merged 1 commit into from
Feb 23, 2021

Conversation

carlossanlop
Copy link
Member

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 with O:.

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 from Warning to Info (default is Hidden).

It should be Info because we still want people to tell people to avoid using prefixes, unless they are using O:.

Here is a docs backporting PR that has to deal with that problem: #48137

@carlossanlop carlossanlop requested a review from safern February 22, 2021 19:15
@carlossanlop carlossanlop self-assigned this Feb 22, 2021
@dotnet-issue-labeler
Copy link

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.

@ghost
Copy link

ghost commented Feb 22, 2021

Tagging subscribers to this area: @ViktorHofer
See info in area-owners.md if you want to be subscribed.

Issue Details

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 with O:.

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 from Warning to Info (default is Hidden).

It should be Info because we still want people to tell people to avoid using prefixes, unless they are using O:.

Here is a docs backporting PR that has to deal with that problem: #48137

Author: carlossanlop
Assignees: carlossanlop
Labels:

area-Infrastructure

Milestone: -

Copy link
Member

@danmoseley danmoseley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@danmoseley danmoseley merged commit 7565d60 into dotnet:master Feb 23, 2021
@carlossanlop carlossanlop deleted the CA1200 branch February 23, 2021 05:43
Copy link
Member

@safern safern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ghost ghost locked as resolved and limited conversation to collaborators Mar 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants