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.

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

Add/improve descriptions #6899

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add/improve descriptions #6899

wants to merge 4 commits into from

Conversation

tmeschter
Copy link
Contributor

In the course of writing an analyzer I encountered the RS1025, RS1026, and RS1036 diagnostics. Based on the existing messages and/or descriptions I couldn't immediately figure out what I was doing wrong or why it mattered. This change adds or updates the associated descriptions to provide some guidance about what the user should do and why.

@tmeschter
Add description for RS1025
7cceda3 
Add a description for RS1025, "Configure generated code analysis", based on the documentation for `AnalysisContext.ConfigureGeneratedCodeAnalysis`. The goal is to use the description to explain _what_ the analyzer developer should do and _why_.
@tmeschter
Add description for RS1026
4369ffb 
Add a description for RS1026, "Enable concurrent execution", based on the documentation for `AnalysisContext.EnableConcurrentExecution`. The goal is to use the description to explain _what_ the analyzer developer should do and _why_.
@tmeschter
Fix up resource value
2f5c019 
The method referred to in the resource is on the `AnalysisContext` class, not `AnalyzerContext`.
@tmeschter
Make a description more informative
3eff96c 
Update the description for RS1036 to explain what turning on `EnforceExtendedAnalyzerRules` will actually do.
@tmeschter tmeschter requested a review from a team as a code owner August 30, 2023 18:10
mavasani
mavasani approved these changes Aug 31, 2023
View reviewed changes
Copy link
Member

@mavasani mavasani left a comment

Choose a reason for hiding this comment

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

Thanks @tmeschter

@mavasani
Copy link
Member

You have a build failure:

One or more auto-generated documentation files were either edited manually, or not updated. Please revert changes made to the following files (if manually edited) and run `msbuild /t:pack` at the root of the repo to automatically update them:
      D:\a\_work\1\s\src\Microsoft.CodeAnalysis.Analyzers\Microsoft.CodeAnalysis.Analyzers.md
      D:\a\_work\1\s\src\Microsoft.CodeAnalysis.Analyzers\Microsoft.CodeAnalysis.Analyzers.sarif

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mavasani mavasani mavasani approved these changes

Assignees
No one assigned
Labels
Community
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tmeschter @mavasani