Skip to content

Commit b448883

Browse files
committed
Update analyzer doc pages for special treatments regarding MSTestAnalysisMode
1 parent ab6f54b commit b448883

File tree

7 files changed

+22
-10
lines changed

7 files changed

+22
-10
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!NOTE]
2+
> This rule is opt-in. It's not enabled even when using `<MSTestAnalysisMode>All</MSTestAnalysisMode>`. For more information about `MSTestAnalysisMode`, see [MSTest code analysis](../overview.md).

docs/core/testing/mstest-analyzers/mstest0003.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ dev_langs:
1616
---
1717
# MSTEST0003: Test methods should have valid layout
1818

19-
| Property | Value |
20-
|-------------------------------------|----------------------------------------------------|
21-
| **Rule ID** | MSTEST0003 |
22-
| **Title** | Test methods should have valid layout |
23-
| **Category** | Usage |
24-
| **Fix is breaking or non-breaking** | Breaking |
25-
| **Enabled by default** | Yes |
26-
| **Default severity** | Warning |
27-
| **Introduced in version** | 3.2.0 |
28-
| **Is there a code fix** | Yes |
19+
| Property | Value |
20+
|-------------------------------------|------------------------------------------------------------------------------------------|
21+
| **Rule ID** | MSTEST0003 |
22+
| **Title** | Test methods should have valid layout |
23+
| **Category** | Usage |
24+
| **Fix is breaking or non-breaking** | Breaking |
25+
| **Enabled by default** | Yes |
26+
| **Default severity** | Warning (escalated to Error when setting `MSTestAnalysisMode` to `Recommended` or `All`) |
27+
| **Introduced in version** | 3.2.0 |
28+
| **Is there a code fix** | Yes |
2929

3030
## Cause
3131

docs/core/testing/mstest-analyzers/mstest0015.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Ensure that the test method isn't ignored.
4040

4141
Do not suppress a warning from this rule. If you ignore this rule, test method will be ignored.
4242

43+
[!INCLUDE [disabled-in-all](includes/disabled-in-all.md)]
44+
4345
## Suppress a warning
4446

4547
If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

docs/core/testing/mstest-analyzers/mstest0019.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Replace the constructor call with a `[TestInitialize]` method.
4040

4141
You usually don't want to suppress warnings from this rule if you decided to opt-in for it.
4242

43+
[!INCLUDE [disabled-in-all](includes/disabled-in-all.md)]
44+
4345
## Suppress a warning
4446

4547
If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

docs/core/testing/mstest-analyzers/mstest0020.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Replace `[TestInitialize]` returning `void` by constructors.
4040

4141
You usually don't want to suppress warnings from this rule if you decided to opt-in for it.
4242

43+
[!INCLUDE [disabled-in-all](includes/disabled-in-all.md)]
44+
4345
## Suppress a warning
4446

4547
If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

docs/core/testing/mstest-analyzers/mstest0021.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Replace `[TestCleanup]` method by `Dispose` or `DisposeAsync` pattern.
4040

4141
You usually don't want to suppress warnings from this rule if you decided to opt-in for it.
4242

43+
[!INCLUDE [disabled-in-all](includes/disabled-in-all.md)]
44+
4345
## Suppress a warning
4446

4547
If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

docs/core/testing/mstest-analyzers/mstest0022.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Replace `Dispose` or `DisposeAsync` methods with `[TestCleanup]`.
4040

4141
You usually don't want to suppress warnings from this rule if you decided to opt-in for it.
4242

43+
[!INCLUDE [disabled-in-all](includes/disabled-in-all.md)]
44+
4345
## Suppress a warning
4446

4547
If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

0 commit comments

Comments
 (0)