Skip to content

Commit

Permalink
Merge pull request #242 from mikkelbu/feat/improve-titles-messages-de…
Browse files Browse the repository at this point in the history
…scriptions

feat: Improve titles, messages, and descriptions
  • Loading branch information
mikkelbu authored May 20, 2020
2 parents 1861ba6 + ba53fd3 commit 7e14137
Show file tree
Hide file tree
Showing 59 changed files with 270 additions and 271 deletions.
12 changes: 6 additions & 6 deletions documentation/NUnit1001.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1001
## The individual arguments provided by a TestCaseAttribute must match the type of the matching parameter of the method.
## The individual arguments provided by a TestCaseAttribute must match the type of the corresponding parameter of the method.

| Topic | Value
| :-- | :--
Expand All @@ -12,7 +12,7 @@

## Description

The individual arguments provided by a TestCaseAttribute must match the type of the matching parameter of the method.
The individual arguments provided by a TestCaseAttribute must match the type of the corresponding parameter of the method.

## Motivation

Expand Down Expand Up @@ -69,21 +69,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1001 // The individual arguments provided by a TestCaseAttribute must match the type of the matching parameter of the method.
#pragma warning disable NUnit1001 // The individual arguments provided by a TestCaseAttribute must match the type of the corresponding parameter of the method.
Code violating the rule here
#pragma warning restore NUnit1001 // The individual arguments provided by a TestCaseAttribute must match the type of the matching parameter of the method.
#pragma warning restore NUnit1001 // The individual arguments provided by a TestCaseAttribute must match the type of the corresponding parameter of the method.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1001 // The individual arguments provided by a TestCaseAttribute must match the type of the matching parameter of the method.
#pragma warning disable NUnit1001 // The individual arguments provided by a TestCaseAttribute must match the type of the corresponding parameter of the method.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1001:The individual arguments provided by a TestCaseAttribute must match the type of the matching parameter of the method.",
"NUnit1001:The individual arguments provided by a TestCaseAttribute must match the type of the corresponding parameter of the method.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
12 changes: 6 additions & 6 deletions documentation/NUnit1002.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1002
## TestCaseSource should use nameof operator to specify target.
## The TestCaseSource should use nameof operator to specify target.

| Topic | Value
| :-- | :--
Expand All @@ -12,7 +12,7 @@

## Description

TestCaseSource should use nameof operator to specify target.
The TestCaseSource should use nameof operator to specify target.

## Motivation

Expand Down Expand Up @@ -67,21 +67,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1002 // TestCaseSource should use nameof operator to specify target.
#pragma warning disable NUnit1002 // The TestCaseSource should use nameof operator to specify target.
Code violating the rule here
#pragma warning restore NUnit1002 // TestCaseSource should use nameof operator to specify target.
#pragma warning restore NUnit1002 // The TestCaseSource should use nameof operator to specify target.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1002 // TestCaseSource should use nameof operator to specify target.
#pragma warning disable NUnit1002 // The TestCaseSource should use nameof operator to specify target.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1002:TestCaseSource should use nameof operator to specify target.",
"NUnit1002:The TestCaseSource should use nameof operator to specify target.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
10 changes: 5 additions & 5 deletions documentation/NUnit1003.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1003
## Too few arguments provided by TestCaseAttribute.
## The TestCaseAttribute provided too few arguments.

| Topic | Value
| :-- | :--
Expand Down Expand Up @@ -67,21 +67,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1003 // Too few arguments provided by TestCaseAttribute.
#pragma warning disable NUnit1003 // The TestCaseAttribute provided too few arguments.
Code violating the rule here
#pragma warning restore NUnit1003 // Too few arguments provided by TestCaseAttribute.
#pragma warning restore NUnit1003 // The TestCaseAttribute provided too few arguments.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1003 // Too few arguments provided by TestCaseAttribute.
#pragma warning disable NUnit1003 // The TestCaseAttribute provided too few arguments.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1003:Too few arguments provided by TestCaseAttribute.",
"NUnit1003:The TestCaseAttribute provided too few arguments.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
10 changes: 5 additions & 5 deletions documentation/NUnit1004.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1004
## Too many arguments provided by TestCaseAttribute.
## The TestCaseAttribute provided too many arguments.

| Topic | Value
| :-- | :--
Expand Down Expand Up @@ -66,21 +66,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1004 // Too many arguments provided by TestCaseAttribute.
#pragma warning disable NUnit1004 // The TestCaseAttribute provided too many arguments.
Code violating the rule here
#pragma warning restore NUnit1004 // Too many arguments provided by TestCaseAttribute.
#pragma warning restore NUnit1004 // The TestCaseAttribute provided too many arguments.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1004 // Too many arguments provided by TestCaseAttribute.
#pragma warning disable NUnit1004 // The TestCaseAttribute provided too many arguments.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1004:Too many arguments provided by TestCaseAttribute.",
"NUnit1004:The TestCaseAttribute provided too many arguments.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
12 changes: 6 additions & 6 deletions documentation/NUnit1005.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1005
## The type of ExpectedResult must match the return type.
## The type of the value specified via ExpectedResult must match the return type of the method.

| Topic | Value
| :-- | :--
Expand All @@ -12,7 +12,7 @@

## Description

The type of ExpectedResult must match the return type. This will lead to an error at run-time.
The type of the value specified via ExpectedResult must match the return type of the method. Otherwise, this will lead to an error at run-time.

## Motivation

Expand Down Expand Up @@ -65,21 +65,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1005 // The type of ExpectedResult must match the return type.
#pragma warning disable NUnit1005 // The type of the value specified via ExpectedResult must match the return type of the method.
Code violating the rule here
#pragma warning restore NUnit1005 // The type of ExpectedResult must match the return type.
#pragma warning restore NUnit1005 // The type of the value specified via ExpectedResult must match the return type of the method.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1005 // The type of ExpectedResult must match the return type.
#pragma warning disable NUnit1005 // The type of the value specified via ExpectedResult must match the return type of the method.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1005:The type of ExpectedResult must match the return type.",
"NUnit1005:The type of the value specified via ExpectedResult must match the return type of the method.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
12 changes: 6 additions & 6 deletions documentation/NUnit1007.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1007
## Method has non-void return type, but no result is expected in ExpectedResult.
## The method has non-void return type, but no result is expected in ExpectedResult.

| Topic | Value
| :-- | :--
Expand All @@ -12,7 +12,7 @@

## Description

Method has non-void return type, but no result is expected in ExpectedResult.
The method has non-void return type, but no result is expected in ExpectedResult.

## Motivation

Expand Down Expand Up @@ -65,21 +65,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1007 // Method has non-void return type, but no result is expected in ExpectedResult.
#pragma warning disable NUnit1007 // The method has non-void return type, but no result is expected in ExpectedResult.
Code violating the rule here
#pragma warning restore NUnit1007 // Method has non-void return type, but no result is expected in ExpectedResult.
#pragma warning restore NUnit1007 // The method has non-void return type, but no result is expected in ExpectedResult.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1007 // Method has non-void return type, but no result is expected in ExpectedResult.
#pragma warning disable NUnit1007 // The method has non-void return type, but no result is expected in ExpectedResult.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1007:Method has non-void return type, but no result is expected in ExpectedResult.",
"NUnit1007:The method has non-void return type, but no result is expected in ExpectedResult.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
10 changes: 5 additions & 5 deletions documentation/NUnit1009.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1009
## No ParallelScope.Children on a non-parameterized test method.
## One may not specify ParallelScope.Children on a non-parameterized test method.

| Topic | Value
| :-- | :--
Expand Down Expand Up @@ -70,21 +70,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1009 // No ParallelScope.Children on a non-parameterized test method.
#pragma warning disable NUnit1009 // One may not specify ParallelScope.Children on a non-parameterized test method.
Code violating the rule here
#pragma warning restore NUnit1009 // No ParallelScope.Children on a non-parameterized test method.
#pragma warning restore NUnit1009 // One may not specify ParallelScope.Children on a non-parameterized test method.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1009 // No ParallelScope.Children on a non-parameterized test method.
#pragma warning disable NUnit1009 // One may not specify ParallelScope.Children on a non-parameterized test method.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1009:No ParallelScope.Children on a non-parameterized test method.",
"NUnit1009:One may not specify ParallelScope.Children on a non-parameterized test method.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
10 changes: 5 additions & 5 deletions documentation/NUnit1010.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1010
## No ParallelScope.Fixtures on a test method.
## One may not specify ParallelScope.Fixtures on a test method.

| Topic | Value
| :-- | :--
Expand Down Expand Up @@ -83,21 +83,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1010 // No ParallelScope.Fixtures on a test method.
#pragma warning disable NUnit1010 // One may not specify ParallelScope.Fixtures on a test method.
Code violating the rule here
#pragma warning restore NUnit1010 // No ParallelScope.Fixtures on a test method.
#pragma warning restore NUnit1010 // One may not specify ParallelScope.Fixtures on a test method.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1010 // No ParallelScope.Fixtures on a test method.
#pragma warning disable NUnit1010 // One may not specify ParallelScope.Fixtures on a test method.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1010:No ParallelScope.Fixtures on a test method.",
"NUnit1010:One may not specify ParallelScope.Fixtures on a test method.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
12 changes: 6 additions & 6 deletions documentation/NUnit1011.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1011
## TestCaseSource argument does not specify an existing member.
## The TestCaseSource argument does not specify an existing member.

| Topic | Value
| :-- | :--
Expand All @@ -12,7 +12,7 @@

## Description

TestCaseSource argument does not specify an existing member. This will lead to an error at run-time.
The TestCaseSource argument does not specify an existing member. This will lead to an error at run-time.

## Motivation

Expand Down Expand Up @@ -80,21 +80,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1011 // TestCaseSource argument does not specify an existing member.
#pragma warning disable NUnit1011 // The TestCaseSource argument does not specify an existing member.
Code violating the rule here
#pragma warning restore NUnit1011 // TestCaseSource argument does not specify an existing member.
#pragma warning restore NUnit1011 // The TestCaseSource argument does not specify an existing member.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1011 // TestCaseSource argument does not specify an existing member.
#pragma warning disable NUnit1011 // The TestCaseSource argument does not specify an existing member.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1011:TestCaseSource argument does not specify an existing member.",
"NUnit1011:The TestCaseSource argument does not specify an existing member.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
12 changes: 6 additions & 6 deletions documentation/NUnit1012.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# NUnit1012
## Async test method must have non-void return type.
## The async test method must have a non-void return type.

| Topic | Value
| :-- | :--
Expand All @@ -12,7 +12,7 @@

## Description

Async test method must have non-void return type.
The async test method must have a non-void return type.

## Motivation

Expand Down Expand Up @@ -68,21 +68,21 @@ Configure the severity per project, for more info see [MSDN](https://msdn.micros

### Via #pragma directive.
```C#
#pragma warning disable NUnit1012 // Async test method must have non-void return type.
#pragma warning disable NUnit1012 // The async test method must have a non-void return type.
Code violating the rule here
#pragma warning restore NUnit1012 // Async test method must have non-void return type.
#pragma warning restore NUnit1012 // The async test method must have a non-void return type.
```

Or put this at the top of the file to disable all instances.
```C#
#pragma warning disable NUnit1012 // Async test method must have non-void return type.
#pragma warning disable NUnit1012 // The async test method must have a non-void return type.
```

### Via attribute `[SuppressMessage]`.

```C#
[System.Diagnostics.CodeAnalysis.SuppressMessage("Structure",
"NUnit1012:Async test method must have non-void return type.",
"NUnit1012:The async test method must have a non-void return type.",
Justification = "Reason...")]
```
<!-- end generated config severity -->
Loading

0 comments on commit 7e14137

Please sign in to comment.