Skip to content

Documentation for diagnostic codes used in repo #48151

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 10, 2023
Merged

Documentation for diagnostic codes used in repo #48151

merged 2 commits into from
May 10, 2023

Conversation

divyeshio
Copy link
Contributor

Documentation for diagnostic codes used in repo

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Description

We currently use diagnostic codes in several places in the repo:

Source generators
MVC analyzers
Framework analyzers
But don't have a central location that documents all of them.

  • This PR is created to document all the diagnostic codes used throughout the repo in one place. Similar to what runtime repo does.

Fixes #47287

@ghost ghost added the community-contribution Indicates that the PR has been added by a community member label May 9, 2023
@ghost
Copy link

ghost commented May 9, 2023

Thanks for your PR, @divyeshio. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@ghost ghost added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label May 9, 2023
captainsafia
captainsafia reviewed May 9, 2023
View reviewed changes
@divyeshio
Copy link
Contributor Author

divyeshio commented May 9, 2023 •
edited
Loading

  • I did a directory wide search for ASP0002, but couldn't find it.
  • Diagnostic codes starting with BL are present in two places : here and here which I think is reasoned in Rationalize Razor Compiler diagnostic IDs #10382 but BL0007 is not present in one of them, not sure if this was intended or not.

@captainsafia
Copy link
Member

  • I did a directory wide search for ASP0002, but couldn't find it.
  • Diagnostic codes starting with BL are present in two places : here and here which I think is reasoned in Rationalize Razor Compiler diagnostic IDs #10382 but BL0007 is not present in one of them, not sure if this was intended or not.

Good discoveries that this process reveals! My suspicion is the gaps in the diagnostic IDs are a result of user error (AKA creating a new analyzer and skipped a value) as opposed to intentional issues.

@mkArtakMSFT mkArtakMSFT added area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels May 9, 2023
mkArtakMSFT
mkArtakMSFT approved these changes May 9, 2023
View reviewed changes
Copy link
Contributor

@mkArtakMSFT mkArtakMSFT left a comment

Choose a reason for hiding this comment

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

Thanks for your help, @divyeshio !

@mkArtakMSFT
Copy link
Contributor

@captainsafia is there anything you're waiting for here ? If not, feel free to merge.

@danmoseley
Copy link
Member

Thanks @divyeshio .. looks like this is your 2nd PR here. We hope you will continue to contribute -- we have over 100 marked "help wanted". - let us know if you need help finding a particular type of issue to work on.

@captainsafia
Copy link
Member

Nope, this is good to merge! I'll in fact be making use of this in a current PR of mine. :)

cc: @eerhardt

@captainsafia captainsafia merged commit b69ed4c into dotnet:main May 10, 2023
@ghost ghost added this to the 8.0-preview5 milestone May 10, 2023
@divyeshio divyeshio deleted the issue-47287 branch September 14, 2023 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@captainsafia captainsafia captainsafia approved these changes

@mkArtakMSFT mkArtakMSFT mkArtakMSFT approved these changes

Assignees

@captainsafia captainsafia

Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Milestone
8.0-preview5
Development

Successfully merging this pull request may close these issues.

Consider in-repo documentation for diagnostic codes used in repo
4 participants
@divyeshio @captainsafia @mkArtakMSFT @danmoseley