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

Make SA1652 a "special" rule (SA0001) #2030

Closed
sharwell opened this issue Jan 7, 2016 · 1 comment
Closed

Make SA1652 a "special" rule (SA0001) #2030

sharwell opened this issue Jan 7, 2016 · 1 comment
Assignees
@sharwell
Labels
enhancement fixed new rule
Milestone
1.1.0 Beta 1

Comments

@sharwell
Copy link
Member

sharwell commented Jan 7, 2016

I propose the following changes to SA1652 (Enable XML documentation output).

  1. Move the rule to the "Special" category (presumably SA0001 or SA0002).
  2. Change the title to "XML comment analysis disabled".
  3. Change the message format to "XML comment analysis is disabled due to project configuration".
  4. Change the analyzer to operate as a compilation end analyzer, which reports a single diagnostic for the project instead of one diagnostic per file.

Renumbering the rule will cause it to appear again for users who previously disabled SA1652, not realizing that it was alerting them to a problem that affected multiple rules.
@vweijsters
Copy link
Contributor

👍

sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jan 7, 2016
@sharwell
Rename SA1652 to SA0001 and improve messaging
82c7d3c 
Fixes DotNetAnalyzers#2030
@sharwell sharwell mentioned this issue Jan 7, 2016
Merged
@sharwell sharwell added this to the 1.1.0 Beta 1 milestone Jan 7, 2016
@sharwell sharwell self-assigned this Jan 7, 2016
sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jan 7, 2016
@sharwell
Rename SA1652 to SA0001 and improve messaging
2630890 
Fixes DotNetAnalyzers#2030
@sharwell sharwell changed the title Proposal: Make SA1652 a "special" rule (SA0xxx) Proposal: Make SA1652 a "special" rule (SA0001) Jan 7, 2016
@sharwell sharwell changed the title Proposal: Make SA1652 a "special" rule (SA0001) Make SA1652 a "special" rule (SA0001) Jan 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sharwell sharwell

Labels
enhancement fixed new rule
Projects
None yet
Milestone
1.1.0 Beta 1
Development

No branches or pull requests
2 participants
@sharwell @vweijsters