Add missing analyzers docs #50819
Open
Add missing analyzers docs #50819
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for seven MSTest analyzer rules (MSTEST0056-MSTEST0062) that were missing from the documentation set. These analyzers will be released in MSTest 4.1 (with two from 4.0.0). The documentation follows the established pattern for analyzer rule documentation with frontmatter, property tables, examples, and suppression guidance.
Key changes:
- Adds 7 new analyzer rule documentation files with comprehensive examples and guidance
- Updates the TOC to include navigation entries for the new rules
- Extends the usage-rules.md summary table with descriptions of the new analyzers
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/navigate/devops-testing/toc.yml | Adds navigation entries for MSTEST0056-MSTEST0062 |
| docs/core/testing/mstest-analyzers/usage-rules.md | Updates the analyzer summary table with 7 new rule entries |
| docs/core/testing/mstest-analyzers/mstest0056.md | Documents the DisplayName property usage rule |
| docs/core/testing/mstest-analyzers/mstest0057.md | Documents the source information propagation rule for custom attributes |
| docs/core/testing/mstest-analyzers/mstest0058.md | Documents avoiding assertions in catch blocks |
| docs/core/testing/mstest-analyzers/mstest0059.md | Documents the Parallelize/DoNotParallelize conflict rule |
| docs/core/testing/mstest-analyzers/mstest0060.md | Documents avoiding duplicate test method attributes |
| docs/core/testing/mstest-analyzers/mstest0061.md | Documents using OSCondition attribute instead of runtime checks |
| docs/core/testing/mstest-analyzers/mstest0062.md | Documents avoiding out/ref parameters in test methods |
gewarren
approved these changes
Dec 29, 2025
Co-authored-by: Genevieve Warren <[email protected]>
Member
Author
|
@gewarren thank you for your review. I have left 2 comments on parts where I would really like your input. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Add the 2 missing shipped analyzers docs + all the rules we will soon be shipping (MSTest 4.1)
cc @Youssef1313
Internal previews
catchblocks