Skip to content

Update docs for analyzers#30

Merged
olstakh merged 4 commits intomainfrom
users/olstakh/update-docs
Apr 9, 2026
Merged

Update docs for analyzers#30
olstakh merged 4 commits intomainfrom
users/olstakh/update-docs

Conversation

@olstakh
Copy link
Copy Markdown
Owner

@olstakh olstakh commented Apr 9, 2026

This pull request significantly improves the documentation for analyzer rules in the docs/Rules directory by adding clear violation examples, detailed suppression guidance, and additional context for each rule. These changes make it easier for users to understand, diagnose, and address rule violations related to dependency-aware test ordering in xUnit.

Key documentation improvements:

  • Violation Examples and Fixes

  • Suppression Guidance

  • MSBuild Property Alternatives

    • Clarified the use of MSBuild properties (e.g., <UseDependencyAwareTestCaseOrderer>, <UseDependencyAwareTestFramework>) as alternatives to manual attribute configuration for several rules. [1] [2] [3] [4] [5] [6] [7]
  • Custom Implementation Guidance

    • Provided advice on custom orderer/framework implementations, including inheritance requirements to ensure dependency ordering works as expected. [1] [2] [3]
  • Consistency and Clarity

    • Standardized the structure of documentation for all rules, ensuring each rule has sections for violation, how to fix, suppression, and relevant code examples. (All references above)

These enhancements will help users quickly identify and resolve test dependency configuration issues in their xUnit test suites.

@olstakh olstakh merged commit 74190be into main Apr 9, 2026
2 checks passed
@olstakh olstakh deleted the users/olstakh/update-docs branch April 9, 2026 05:53
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