Skip to content

Commit c7d10a4

Browse files
committed
Fix references to coroutineContext is the docs of all the builders
1 parent 61cafea commit c7d10a4

File tree

13 files changed

+14
-15
lines changed

13 files changed

+14
-15
lines changed

core/kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/channels/Actor.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ interface ActorJob<in E> : SendChannel<E> {
5656
*
5757
* The [context] for the new coroutine can be explicitly specified.
5858
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
59-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
59+
* The [coroutineContext] of the parent coroutine may be used,
6060
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
6161
* The parent job may be also explicitly specified using [parent] parameter.
6262
*

core/kotlinx-coroutines-core/src/main/kotlin/kotlinx/coroutines/experimental/channels/Produce.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ interface ProducerJob<out E> : ReceiveChannel<E>, Job {
5656
*
5757
* The [context] for the new coroutine can be explicitly specified.
5858
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
59-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
59+
* The [coroutineContext] of the parent coroutine may be used,
6060
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
6161
* The parent job may be also explicitly specified using [parent] parameter.
6262
*

integration/kotlinx-coroutines-guava/src/main/kotlin/kotlinx/coroutines/experimental/guava/ListenableFuture.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import kotlin.coroutines.experimental.*
2828
*
2929
* The [context] for the new coroutine can be explicitly specified.
3030
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
31-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
31+
* The [coroutineContext] of the parent coroutine may be used,
3232
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3333
* The parent job may be also explicitly specified using [parent] parameter.
3434
*

reactive/kotlinx-coroutines-reactive/src/main/kotlin/kotlinx/coroutines/experimental/reactive/Publish.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import kotlin.coroutines.experimental.*
4040
*
4141
* The [context] for the new coroutine can be explicitly specified.
4242
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
43-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
43+
* The [coroutineContext] of the parent coroutine may be used,
4444
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
4545
* The parent job may be also explicitly specified using [parent] parameter.
4646

reactive/kotlinx-coroutines-reactor/src/main/kotlin/kotlinx/coroutines/experimental/reactor/Mono.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import kotlin.coroutines.experimental.*
3333
*
3434
* The [context] for the new coroutine can be explicitly specified.
3535
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
36-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
36+
* The [coroutineContext] of the parent coroutine may be used,
3737
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3838
* The parent job may be also explicitly specified using [parent] parameter.
3939
*

reactive/kotlinx-coroutines-rx1/src/main/kotlin/kotlinx/coroutines/experimental/rx1/RxCompletable.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import kotlin.coroutines.experimental.*
3232
*
3333
* The [context] for the new coroutine can be explicitly specified.
3434
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
35-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
35+
* The [coroutineContext] of the parent coroutine may be used,
3636
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3737
* The parent job may be also explicitly specified using [parent] parameter.
3838
*

reactive/kotlinx-coroutines-rx1/src/main/kotlin/kotlinx/coroutines/experimental/rx1/RxObservable.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import kotlin.coroutines.experimental.*
4040
*
4141
* The [context] for the new coroutine can be explicitly specified.
4242
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
43-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
43+
* The [coroutineContext] of the parent coroutine may be used,
4444
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
4545
* The parent job may be also explicitly specified using [parent] parameter.
4646
*

reactive/kotlinx-coroutines-rx1/src/main/kotlin/kotlinx/coroutines/experimental/rx1/RxSingle.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import kotlin.coroutines.experimental.*
3232
*
3333
* The [context] for the new coroutine can be explicitly specified.
3434
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
35-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
35+
* The [coroutineContext] of the parent coroutine may be used,
3636
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3737
* The parent job may be also explicitly specified using [parent] parameter.
3838
*

reactive/kotlinx-coroutines-rx2/src/main/kotlin/kotlinx/coroutines/experimental/rx2/RxCompletable.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import kotlin.coroutines.experimental.*
3333
*
3434
* The [context] for the new coroutine can be explicitly specified.
3535
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
36-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
36+
* The [coroutineContext] of the parent coroutine may be used,
3737
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3838
* The parent job may be also explicitly specified using [parent] parameter.
3939
*

reactive/kotlinx-coroutines-rx2/src/main/kotlin/kotlinx/coroutines/experimental/rx2/RxFlowable.kt

+2-3
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ import kotlinx.coroutines.experimental.DefaultDispatcher
2323
import kotlinx.coroutines.experimental.Job
2424
import kotlinx.coroutines.experimental.channels.ProducerScope
2525
import kotlinx.coroutines.experimental.reactive.publish
26-
import kotlin.coroutines.experimental.ContinuationInterceptor
27-
import kotlin.coroutines.experimental.CoroutineContext
26+
import kotlin.coroutines.experimental.*
2827

2928
/**
3029
* Creates cold [flowable][Flowable] that will run a given [block] in a coroutine.
@@ -42,7 +41,7 @@ import kotlin.coroutines.experimental.CoroutineContext
4241
*
4342
* The [context] for the new coroutine can be explicitly specified.
4443
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
45-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
44+
* The [coroutineContext] of the parent coroutine may be used,
4645
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
4746
* If the context does not have any dispatcher nor any other [ContinuationInterceptor], then [DefaultDispatcher] is used.
4847
*

reactive/kotlinx-coroutines-rx2/src/main/kotlin/kotlinx/coroutines/experimental/rx2/RxMaybe.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import kotlin.coroutines.experimental.*
3434
*
3535
* The [context] for the new coroutine can be explicitly specified.
3636
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
37-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
37+
* The [coroutineContext] of the parent coroutine may be used,
3838
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3939
* The parent job may be also explicitly specified using [parent] parameter.
4040
*

reactive/kotlinx-coroutines-rx2/src/main/kotlin/kotlinx/coroutines/experimental/rx2/RxObservable.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import kotlin.coroutines.experimental.*
4141
*
4242
* The [context] for the new coroutine can be explicitly specified.
4343
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
44-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
44+
* The [coroutineContext] of the parent coroutine may be used,
4545
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
4646
* The parent job may be also explicitly specified using [parent] parameter.
4747
*

reactive/kotlinx-coroutines-rx2/src/main/kotlin/kotlinx/coroutines/experimental/rx2/RxSingle.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import kotlin.coroutines.experimental.*
3333
*
3434
* The [context] for the new coroutine can be explicitly specified.
3535
* See [CoroutineDispatcher] for the standard context implementations that are provided by `kotlinx.coroutines`.
36-
* The [context][CoroutineScope.context] of the parent coroutine from its [scope][CoroutineScope] may be used,
36+
* The [coroutineContext] of the parent coroutine may be used,
3737
* in which case the [Job] of the resulting coroutine is a child of the job of the parent coroutine.
3838
* The parent job may be also explicitly specified using [parent] parameter.
3939
*

0 commit comments

Comments
 (0)