Improve formatting documentation (#4473)

detekt · Jan 8, 2022 · c5beaf5 · c5beaf5
1 parent 83cdc23
commit c5beaf5
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/...kt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/Filename.kt b/...kt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/Filename.kt
@@ -7,6 +7,9 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule
 
 /**
  * See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
+ *
+ * This rules overlaps with [`naming>MatchingDeclarationName`](https://detekt.github.io/detekt/naming.html#matchingdeclarationname)
+ * from the standard rules, make sure to enable just one.
  */
 @ActiveByDefault(since = "1.0.0")
 class Filename(config: Config) : FormattingRule(config) {

diff --git a/...ormatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/FinalNewline.kt b/...ormatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/FinalNewline.kt
@@ -12,6 +12,9 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule
 
 /**
  * See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
+ *
+ * This rules overlaps with [`style>NewLineAtEndOfFile`](https://detekt.github.io/detekt/style.html#newlineatendoffile)
+ * from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.
  */
 @OptIn(FeatureInAlphaState::class)
 @ActiveByDefault(since = "1.0.0")

diff --git a/...ting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/MaximumLineLength.kt b/...ting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/MaximumLineLength.kt
@@ -14,7 +14,9 @@ import io.gitlab.arturbosch.detekt.formatting.MAX_LINE_LENGTH_KEY
 /**
  * See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
  *
- * This rules overlaps with [`MaxLineLength`](https://detekt.github.io/detekt/style.html#maxlinelength) from the standard rules, make sure to enable just one or keep them aligned.
+ * This rules overlaps with [`style>MaxLineLength`](https://detekt.github.io/detekt/style.html#maxlinelength)
+ * from the standard rules, make sure to enable just one or keep them aligned. The pro of this rule is that it can
+ * auto-correct the issue.
  */
 @ActiveByDefault(since = "1.0.0")
 @OptIn(FeatureInAlphaState::class)

diff --git a/...tting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/ModifierOrdering.kt b/...tting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/ModifierOrdering.kt
@@ -8,6 +8,9 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule
 
 /**
  * See <a href="https://ktlint.github.io/#rule-modifier-order">ktlint-website</a> for documentation.
+ *
+ * This rules overlaps with [`style>ModifierOrder`](https://detekt.github.io/detekt/style.html#modifierorder)
+ * from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.
  */
 @ActiveByDefault(since = "1.0.0")
 @AutoCorrectable(since = "1.0.0")