Formulate rule/complexity descriptions consistently (#4417)

* Formulate rule/complexity descriptions consistently reference #4384 * Apply suggestions from code review for msg Co-authored-by: Chao Zhang <zhangchao6865@gmail.com> Co-authored-by: Chao Zhang <zhangchao6865@gmail.com>
detekt · Dec 28, 2021 · 1f26c47 · 1f26c47
1 parent 634d29a
commit 1f26c47
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/...complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt b/...complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt
@@ -37,7 +37,7 @@ class NamedArguments(config: Config = Config.empty) : Rule(config) {
     override val issue = Issue(
         "NamedArguments",
         Severity.Maintainability,
-        "Parameters of function invocation must all be named",
+        "Named arguments are required for function invocation with many parameters.",
         Debt.FIVE_MINS
     )
 

diff --git a/...c/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt b/...c/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt
@@ -45,7 +45,7 @@ class ReplaceSafeCallChainWithRun(config: Config = Config.empty) : Rule(config)
     override val issue = Issue(
         javaClass.simpleName,
         Severity.Maintainability,
-        "Chains of safe calls on non-nullable types can be surrounded with run {}",
+        "Chains of safe calls on non-nullable types can be surrounded with `run {}`.",
         Debt.TEN_MINS
     )
 

diff --git a/.../src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt b/.../src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt
@@ -48,7 +48,8 @@ class StringLiteralDuplication(config: Config = Config.empty) : Rule(config) {
     override val issue = Issue(
         javaClass.simpleName,
         Severity.Maintainability,
-        "Multiple occurrences of the same string literal within a single file detected.",
+        "Multiple occurrences of the same string literal within a single file detected. " +
+            "Prefer extracting the string literal into a property or constant.",
         Debt.FIVE_MINS
     )