More precise SharedFlow lint message (Kotlin#2830)

vadimsemenov · Jul 20, 2021 · 3694ac9 · 3694ac9
1 parent a3429f7
commit 3694ac9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/kotlinx-coroutines-core/common/src/flow/operators/Lint.kt b/kotlinx-coroutines-core/common/src/flow/operators/Lint.kt
@@ -83,7 +83,8 @@ public val FlowCollector<*>.coroutineContext: CoroutineContext
     get() = noImpl()
 
 @Deprecated(
-    message = "SharedFlow never completes, so this operator has no effect.",
+    message = "SharedFlow never completes, so this operator typically has not effect, it can only " +
+        "catch exceptions from 'onSubscribe' operator",
     level = DeprecationLevel.WARNING,
     replaceWith = ReplaceWith("this")
 )

diff --git a/kotlinx-coroutines-core/common/test/flow/sharing/SharedFlowTest.kt b/kotlinx-coroutines-core/common/test/flow/sharing/SharedFlowTest.kt
@@ -602,6 +602,7 @@ class SharedFlowTest : TestBase() {
     }
 
     @Test
+    @Suppress("DEPRECATION") // 'catch'
     fun onSubscriptionThrows() = runTest {
         expect(1)
         val sh = MutableSharedFlow<String>(1)