documentation updates for CA2017

Kritner · Apr 11, 2024 · 4c41c4e · 4c41c4e
1 parent b5fca9c
commit 4c41c4e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/NetAnalyzers/Microsoft.CodeAnalysis.NetAnalyzers.md b/src/NetAnalyzers/Microsoft.CodeAnalysis.NetAnalyzers.md
@@ -1944,9 +1944,9 @@ Forward the 'CancellationToken' parameter to methods to ensure the operation can
 |CodeFix|True|
 ---
 
-## [CA2017](https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2017): Parameter count mismatch
+## [CA2017](https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2017): Message templates should have the correct number of parameters and braces
 
-Number of parameters supplied in the logging message template do not match the number of named placeholders.
+The number of parameters supplied in the logging message template do not match the number of named placeholders or the braces supplied are invalid.
 
 |Item|Value|
 |-|-|

diff --git a/src/NetAnalyzers/Microsoft.CodeAnalysis.NetAnalyzers.sarif b/src/NetAnalyzers/Microsoft.CodeAnalysis.NetAnalyzers.sarif
@@ -3516,8 +3516,8 @@
         },
         "CA2017": {
           "id": "CA2017",
-          "shortDescription": "Parameter count mismatch",
-          "fullDescription": "Number of parameters supplied in the logging message template do not match the number of named placeholders.",
+          "shortDescription": "Message templates should have the correct number of parameters and braces",
+          "fullDescription": "The number of parameters supplied in the logging message template do not match the number of named placeholders or the braces supplied are invalid..",
           "defaultLevel": "warning",
           "helpUri": "https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2017",
           "properties": {