Documentation updates for compiler warnings. #13083
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We had published documentation for analyzers shipped in NET9 - https://learn.microsoft.com/en-us/dotnet/desktop/winforms/compiler-messages/wfo0002?view=netdesktop-9.0 list-of-diagnostics file contains full list of the compiler warnings and errors, obsoletions, experimental features and diagnostics reported by our analyzers. This will help picking up the next number when adding a new ID. I also added notes on the updated documentation steps. Our local analyzer help files are duplicating information from the "learn" site, but they are useful for analyzers that are shipped in preview and not yet documented. I updated these files with newer links, added missing analyzer and removed one that was duplicated in 3 files, assuming that the "learn" site is the main source of information for the users. One of the analyzer error messages is updated to follow the common format - emphasize API name with ticks. Removed unused diagnostic ID Updated AnalyzerReleases files with correst history of when they were shipped and the newly published documentation links
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #13083 +/- ##
===================================================
+ Coverage 60.86786% 61.02608% +0.15822%
===================================================
Files 1537 1539 +2
Lines 157860 158039 +179
Branches 14719 14721 +2
===================================================
+ Hits 96086 96445 +359
+ Misses 61088 60900 -188
- Partials 686 694 +8
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
merriemcgaw
approved these changes
Mar 7, 2025
JeremyKuhne
approved these changes
Mar 7, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 had published documentation for analyzers shipped in NET9 - https://learn.microsoft.com/dotnet/desktop/winforms/compiler-messages/wfo0002
list-of-diagnostics file contains full list of the compiler warnings and errors, obsoletions, experimental features and diagnostics reported by our analyzers. This will help picking up the next number when adding a new ID. I also added notes on the updated documentation steps.
Our local analyzer help files are duplicating information from the "learn" site, but they are useful for analyzers that are shipped in preview and not yet documented. I updated these files with newer links, added missing analyzer and removed one that was duplicated in 3 files, assuming that the "learn" site is the main source of information for the users.
One of the analyzer error messages is updated to follow the common format - emphasize API name with ticks.
Removed unused diagnostic ID
Updated
AnalyzerReleasesfiles with correct history of when analyzers were shipped and the newly published documentation linksMicrosoft Reviewers: Open in CodeFlow