Skip to content

Improve annotations documentation and rule references#1151

Merged
meziantou merged 1 commit into
mainfrom
meziantou/annotations-docs
May 12, 2026
Merged

Improve annotations documentation and rule references#1151
meziantou merged 1 commit into
mainfrom
meziantou/annotations-docs

Conversation

@meziantou
Copy link
Copy Markdown
Owner

Why

Users configuring annotation-based rules reported that it was not obvious that Meziantou.Analyzer.Annotations is a separate package dependency. The docs now make that requirement explicit directly from each impacted rule page.

What changed

  • Updated rule docs that use annotation attributes to clearly state the dependency and link to the annotations project README:
    • MA0003, MA0011, MA0042, MA0045, MA0075, MA0076, MA0124, MA0139, MA0185
  • Expanded src/Meziantou.Analyzer.Annotations/README.md to serve as the central reference with:
    • install guidance (dotnet add package Meziantou.Analyzer.Annotations)
    • source-copy guidance (namespace/type-name matching, public or internal)
    • a table mapping annotation attributes to related rules
  • Updated .github/copilot-instructions.md so changes under src/Meziantou.Analyzer.Annotations require:
    • updating the annotations README
    • bumping the annotations package version
  • Bumped src/Meziantou.Analyzer.Annotations/Meziantou.Analyzer.Annotations.csproj version to 1.3.1.

Notes

This keeps documentation discoverability high from rule pages while using the package README as the single source of truth for annotation usage.

@meziantou meziantou merged commit e4d15f9 into main May 12, 2026
13 checks passed
@meziantou meziantou deleted the meziantou/annotations-docs branch May 12, 2026 16:05
This was referenced May 12, 2026
This was referenced May 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant