Skip to content

Commit d8f1fdc

Browse files
committed
Update docs.
1 parent db95483 commit d8f1fdc

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

AspNetCoreAnalyzers/ASP003ParameterSymbolType.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ internal static class ASP003ParameterSymbolType
88

99
internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(
1010
id: DiagnosticId,
11-
title: "Parameter type does not match.",
12-
messageFormat: "Parameter type does not match.",
11+
title: "Parameter type does not match the type specified by the route parameter.",
12+
messageFormat: "Parameter type does not match the type specified by the route parameter.",
1313
category: AnalyzerCategory.Routing,
1414
defaultSeverity: DiagnosticSeverity.Warning,
1515
isEnabledByDefault: true,
16-
description: "Parameter type does not match.",
16+
description: "Parameter type does not match the type specified by the route parameter.",
1717
helpLinkUri: HelpLink.ForId(DiagnosticId));
1818
}
1919
}

AspNetCoreAnalyzers/ASP004RouteParameterType.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ internal static class ASP004RouteParameterType
88

99
internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(
1010
id: DiagnosticId,
11-
title: "Route parameter type does not match.",
12-
messageFormat: "Route parameter type does not match.",
11+
title: "Route parameter type does not match the method parameter type.",
12+
messageFormat: "Route parameter type does not match the method parameter type.",
1313
category: AnalyzerCategory.Routing,
1414
defaultSeverity: DiagnosticSeverity.Warning,
1515
isEnabledByDefault: true,
16-
description: "Route parameter type does not match.",
16+
description: "Route parameter type does not match the method parameter type.",
1717
helpLinkUri: HelpLink.ForId(DiagnosticId));
1818
}
1919
}

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Roslyn analyzers for ASP.NET.Core.
2121
</tr>
2222
<tr>
2323
<td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP003.md">ASP003</a></td>
24-
<td>Parameter type does not match.</td>
24+
<td>Parameter type does not match the type specified by the route parameter.</td>
2525
</tr>
2626
<tr>
2727
<td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP004.md">ASP004</a></td>
28-
<td>Route parameter type does not match.</td>
28+
<td>Route parameter type does not match the method parameter type.</td>
2929
</tr>
3030
<tr>
3131
<td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP005.md">ASP005</a></td>

documentation/ASP003.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ASP003
2-
## Parameter type does not match.
2+
## Parameter type does not match the type specified by the route parameter.
33

44
<!-- start generated table -->
55
<table>
@@ -28,7 +28,7 @@
2828

2929
## Description
3030

31-
Parameter type does not match.
31+
Parameter type does not match the type specified by the route parameter.
3232

3333
## Motivation
3434

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

4848
### Via #pragma directive.
4949
```C#
50-
#pragma warning disable ASP003 // Parameter type does not match.
50+
#pragma warning disable ASP003 // Parameter type does not match the type specified by the route parameter.
5151
Code violating the rule here
52-
#pragma warning restore ASP003 // Parameter type does not match.
52+
#pragma warning restore ASP003 // Parameter type does not match the type specified by the route parameter.
5353
```
5454

5555
Or put this at the top of the file to disable all instances.
5656
```C#
57-
#pragma warning disable ASP003 // Parameter type does not match.
57+
#pragma warning disable ASP003 // Parameter type does not match the type specified by the route parameter.
5858
```
5959

6060
### Via attribute `[SuppressMessage]`.
6161

6262
```C#
6363
[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing",
64-
"ASP003:Parameter type does not match.",
64+
"ASP003:Parameter type does not match the type specified by the route parameter.",
6565
Justification = "Reason...")]
6666
```
6767
<!-- end generated config severity -->

documentation/ASP004.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ASP004
2-
## Route parameter type does not match.
2+
## Route parameter type does not match the method parameter type.
33

44
<!-- start generated table -->
55
<table>
@@ -28,7 +28,7 @@
2828

2929
## Description
3030

31-
Route parameter type does not match.
31+
Route parameter type does not match the method parameter type.
3232

3333
## Motivation
3434

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

4848
### Via #pragma directive.
4949
```C#
50-
#pragma warning disable ASP004 // Route parameter type does not match.
50+
#pragma warning disable ASP004 // Route parameter type does not match the method parameter type.
5151
Code violating the rule here
52-
#pragma warning restore ASP004 // Route parameter type does not match.
52+
#pragma warning restore ASP004 // Route parameter type does not match the method parameter type.
5353
```
5454

5555
Or put this at the top of the file to disable all instances.
5656
```C#
57-
#pragma warning disable ASP004 // Route parameter type does not match.
57+
#pragma warning disable ASP004 // Route parameter type does not match the method parameter type.
5858
```
5959

6060
### Via attribute `[SuppressMessage]`.
6161

6262
```C#
6363
[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing",
64-
"ASP004:Route parameter type does not match.",
64+
"ASP004:Route parameter type does not match the method parameter type.",
6565
Justification = "Reason...")]
6666
```
6767
<!-- end generated config severity -->

0 commit comments

Comments
 (0)