Formulate rule/naming descriptions consistently (#4419)

reference #4384
detekt · Dec 28, 2021 · d98e43a · d98e43a
1 parent d111fe4
commit d98e43a
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/...-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/BooleanPropertyNaming.kt b/...-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/BooleanPropertyNaming.kt
@@ -37,7 +37,7 @@ class BooleanPropertyNaming(config: Config = Config.empty) : Rule(config) {
 
     override val issue = Issue(
         javaClass.simpleName, Severity.CodeSmell,
-        "Boolean property name should follow the naming convention set in the projects configuration",
+        "Boolean property name should follow the naming convention set in the projects configuration.",
         Debt.FIVE_MINS
     )
 

diff --git a/detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/ClassNaming.kt b/detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/ClassNaming.kt
@@ -24,7 +24,7 @@ class ClassNaming(config: Config = Config.empty) : Rule(config) {
     override val issue = Issue(
         javaClass.simpleName,
         Severity.Style,
-        "A class or object's name should fit the naming pattern defined in the projects configuration.",
+        "A class or object name should fit the naming pattern defined in the projects configuration.",
         debt = Debt.FIVE_MINS
     )
 

diff --git a/...-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/NoNameShadowing.kt b/...-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/NoNameShadowing.kt
@@ -53,7 +53,7 @@ class NoNameShadowing(config: Config = Config.empty) : Rule(config) {
     override val issue = Issue(
         javaClass.simpleName,
         Severity.Defect,
-        "Disallows shadowing variable declarations.",
+        "Disallow shadowing variable declarations.",
         Debt.FIVE_MINS
     )
 

diff --git a/.../main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/NonBooleanPropertyPrefixedWithIs.kt b/.../main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/NonBooleanPropertyPrefixedWithIs.kt
@@ -37,7 +37,7 @@ class NonBooleanPropertyPrefixedWithIs(config: Config = Config.empty) : Rule(con
     override val issue = Issue(
         javaClass.simpleName,
         Severity.Warning,
-        "Only boolean property names can start with 'is' prefix.",
+        "Only boolean property names can start with `is` prefix.",
         debt = Debt.FIVE_MINS
     )