Improve ParTupled documentation (arrow-kt#2821)

lgtout · Feb 6, 2023 · b764a6f · b764a6f
1 parent 083bed2
commit b764a6f
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/ParTupled.kt b/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/ParTupled.kt
@@ -8,6 +8,9 @@ import kotlin.coroutines.EmptyCoroutineContext
 /**
  * Runs [fa], [fb] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -39,6 +42,9 @@ public suspend inline fun <A, B> parTupled(
 /**
  * Runs [fa], [fb], [fc] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -73,6 +79,9 @@ public suspend inline fun <A, B, C> parTupled(
 /**
  * Runs [fa], [fb], [fc], [fd] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -110,6 +119,9 @@ public suspend inline fun <A, B, C, D> parTupled(
 /**
  * Runs [fa], [fb], [fc], [fd], [fe] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -150,6 +162,9 @@ public suspend inline fun <A, B, C, D, E> parTupled(
 /**
  * Runs [fa], [fb], [fc], [fd], [fe], [ff] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -193,6 +208,9 @@ public suspend inline fun <A, B, C, D, E, F> parTupled(
 /**
  * Runs [fa], [fb], [fc], [fd], [fe], [ff], [fg] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -239,6 +257,9 @@ public suspend inline fun <A, B, C, D, E, F, G> parTupled(
 /**
  * Runs [fa], [fb], [fc], [fd], [fe], [ff], [fg], [fh] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers
@@ -288,6 +309,9 @@ public suspend inline fun <A, B, C, D, E, F, G, H> parTupled(
 /**
  * Runs [fa], [fb], [fc], [fd], [fe], [ff], [fg], [fh], [fi] in parallel on [ctx] and combines their results as a tuple.
  *
+ * Coroutine context is inherited from caller, additional context elements can be specified with [context] argument.
+ * If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [Dispatchers.Default] is used.
+ *
  * ```kotlin
  * import arrow.fx.coroutines.*
  * import kotlinx.coroutines.Dispatchers