Modify the KDoc for awaitAll (#3187)

b0ri5 · web-flow · commit 5841effaf9ce · 2022-02-14T12:46:42.000+03:00
It seems like there is an extra "when" and a missing "for".
diff --git a/kotlinx-coroutines-core/common/src/Await.kt b/kotlinx-coroutines-core/common/src/Await.kt
@@ -29,8 +29,8 @@ public suspend fun <T> awaitAll(vararg deferreds: Deferred<T>): List<T> =
  * when all deferred computations are complete or resumes with the first thrown exception if any of computations
  * complete exceptionally including cancellation.
  *
- * This function is **not** equivalent to `this.map { it.await() }` which fails only when when it sequentially
- * gets to wait the failing deferred, while this `awaitAll` fails immediately as soon as any of the deferreds fail.
+ * This function is **not** equivalent to `this.map { it.await() }` which fails only when it sequentially
+ * gets to wait for the failing deferred, while this `awaitAll` fails immediately as soon as any of the deferreds fail.
  *
  * This suspending function is cancellable.
  * If the [Job] of the current coroutine is cancelled or completed while this suspending function is waiting,

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,8 @@ public suspend fun <T> awaitAll(vararg deferreds: Deferred<T>): List<T> =`
`29`	`29`	`* when all deferred computations are complete or resumes with the first thrown exception if any of computations`
`30`	`30`	`* complete exceptionally including cancellation.`
`31`	`31`	`*`
`32`		- * This function is not equivalent to `this.map { it.await() }` which fails only when when it sequentially
`33`		- * gets to wait the failing deferred, while this `awaitAll` fails immediately as soon as any of the deferreds fail.
	`32`	+ * This function is not equivalent to `this.map { it.await() }` which fails only when it sequentially
	`33`	+ * gets to wait for the failing deferred, while this `awaitAll` fails immediately as soon as any of the deferreds fail.
`34`	`34`	`*`
`35`	`35`	`* This suspending function is cancellable.`
`36`	`36`	`* If the [Job] of the current coroutine is cancelled or completed while this suspending function is waiting,`