Improve consumeAsFlow documentation

qwwdfsad · qwwdfsad · commit 1200d476dafb · 2019-10-09T13:40:11.000+03:00
Fixed #1576
diff --git a/kotlinx-coroutines-core/common/src/flow/Channels.kt b/kotlinx-coroutines-core/common/src/flow/Channels.kt
@@ -71,7 +71,7 @@ public suspend fun <T> FlowCollector<T>.emitAll(channel: ReceiveChannel<T>) {
  * ### Cancellation semantics
  *
  * 1) Flow consumer is cancelled when the original channel is cancelled.
- * 2) Flow consumer completes normally when the original channel completes (~is closed) normally.
+ * 2) Flow consumer completes normally when the original channel was closed normally and then fully consumed.
  * 3) If the flow consumer fails with an exception, channel is cancelled.
  *
  * ### Operator fusion

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public suspend fun <T> FlowCollector<T>.emitAll(channel: ReceiveChannel<T>) {`
`71`	`71`	`* ### Cancellation semantics`
`72`	`72`	`*`
`73`	`73`	`* 1) Flow consumer is cancelled when the original channel is cancelled.`
`74`		`- * 2) Flow consumer completes normally when the original channel completes (~is closed) normally.`
	`74`	`+ * 2) Flow consumer completes normally when the original channel was closed normally and then fully consumed.`
`75`	`75`	`* 3) If the flow consumer fails with an exception, channel is cancelled.`
`76`	`76`	`*`
`77`	`77`	`* ### Operator fusion`