Clarify documentation of launchIn (#4144)

rohandhruva · web-flow · commit 81ab2e76cad5 · 2024-06-25T19:26:50.000+02:00
diff --git a/kotlinx-coroutines-core/common/src/flow/terminal/Collect.kt b/kotlinx-coroutines-core/common/src/flow/terminal/Collect.kt
@@ -40,7 +40,7 @@ public suspend fun Flow<*>.collect(): Unit = collect(NopCollector)
  *     .launchIn(uiScope)
  * ```
  *
- * Note that the resulting value of [launchIn] is not used and the provided scope takes care of cancellation.
+ * In this example, note that the `job` returned by [launchIn] is not used, and the provided scope takes care of cancellation.
  */
 public fun <T> Flow<T>.launchIn(scope: CoroutineScope): Job = scope.launch {
     collect() // tail-call

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public suspend fun Flow<*>.collect(): Unit = collect(NopCollector)`
`40`	`40`	`* .launchIn(uiScope)`
`41`	`41`	* ```
`42`	`42`	`*`
`43`		`- * Note that the resulting value of [launchIn] is not used and the provided scope takes care of cancellation.`
	`43`	+ * In this example, note that the `job` returned by [launchIn] is not used, and the provided scope takes care of cancellation.
`44`	`44`	`*/`
`45`	`45`	`public fun <T> Flow<T>.launchIn(scope: CoroutineScope): Job = scope.launch {`
`46`	`46`	`collect() // tail-call`