SwallowedException: Slightly improve the documentation (#3527)

As a follow-up to #3525.
detekt · Mar 7, 2021 · 2705e6b · 2705e6b
1 parent 9cf9f08
commit 2705e6b
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/...ptions/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/exceptions/SwallowedException.kt b/...ptions/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/exceptions/SwallowedException.kt
@@ -26,7 +26,7 @@ import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
 
 /**
  * Exceptions should not be swallowed. This rule reports all instances where exceptions are `caught` and not correctly
- * passed into a newly thrown exception.
+ * passed (e.g. as a cause) into a newly thrown exception.
  *
  * <noncompliant>
  * fun foo() {
@@ -63,7 +63,7 @@ import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
  * }
  * </compliant>
  *
- * @configuration ignoredExceptionTypes - exception types which should be ignored by this rule
+ * @configuration ignoredExceptionTypes - exception types which should be ignored (both in the catch clause and body)
  * (default: `- InterruptedException
  *            - NumberFormatException
  *            - ParseException