Extend the issue description by providing the 'why'

detekt · Sep 25, 2020 · 8cfc906 · 8cfc906
1 parent 27dea52
commit 8cfc906
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/.../main/kotlin/io/gitlab/arturbosch/detekt/rules/coroutines/SuspendFunWithFlowReturnType.kt b/.../main/kotlin/io/gitlab/arturbosch/detekt/rules/coroutines/SuspendFunWithFlowReturnType.kt
@@ -63,7 +63,9 @@ class SuspendFunWithFlowReturnType(config: Config) : Rule(config) {
     override val issue = Issue(
         id = "SuspendFunWithFlowReturnType",
         severity = Severity.Minor,
-        description = "`suspend` modifier should not be used for functions returning Coroutines Flow",
+        description = "`suspend` modifier should not be used for functions returning Coroutines " +
+            "Flow. Flows are cold streams and invoking a function that returns one should not " +
+            "produce any side effects.",
         debt = Debt.TEN_MINS
     )