Skip to content

Commit ebe519a

Browse files
Inegoelizarov
authored andcommitted
Fix "note that" comma everywhere
1 parent e29b035 commit ebe519a

33 files changed

+54
-54
lines changed

CHANGES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Visible consequences of include more robust exception handling for large corouti
215215
* Distribution no longer uses multi-version jar which is not supported on Android (see #510).
216216
* JS version of the library does not depend on AtomicFu anymore:
217217
  All the atomic boxes in JS are fully erased.
218-
* Note, that versions 0.25.1-2 are skipped for technical reasons (they were not fully released).
218+
* Note that versions 0.25.1-2 are skipped for technical reasons (they were not fully released).
219219

220220
## Version 0.25.0
221221

docs/channels.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ The output of this code is:
341341

342342
<!--- TEST -->
343343

344-
Note, that you can build the same pipeline using
344+
Note that you can build the same pipeline using
345345
[`iterator`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/iterator.html)
346346
coroutine builder from the standard library.
347347
Replace `produce` with `iterator`, `send` with `yield`, `receive` with `next`,
@@ -445,7 +445,7 @@ Processor #3 received 10
445445

446446
<!--- TEST lines.size == 10 && lines.withIndex().all { (i, line) -> line.startsWith("Processor #") && line.endsWith(" received ${i + 1}") } -->
447447

448-
Note, that cancelling a producer coroutine closes its channel, thus eventually terminating iteration
448+
Note that cancelling a producer coroutine closes its channel, thus eventually terminating iteration
449449
over the channel that processor coroutines are doing.
450450

451451
Also, pay attention to how we explicitly iterate over channel with `for` loop to perform fan-out in `launchProcessor` code.
@@ -627,7 +627,7 @@ pong Ball(hits=4)
627627

628628
<!--- TEST -->
629629

630-
Note, that sometimes channels may produce executions that look unfair due to the nature of the executor
630+
Note that sometimes channels may produce executions that look unfair due to the nature of the executor
631631
that is being used. See [this issue](https://github.com/Kotlin/kotlinx.coroutines/issues/111) for details.
632632

633633
### Ticker channels

docs/composing-suspending-functions.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Completed in 1017 ms
162162
<!--- TEST ARBITRARY_TIME -->
163163

164164
This is twice as fast, because we have concurrent execution of two coroutines.
165-
Note, that concurrency with coroutines is always explicit.
165+
Note that concurrency with coroutines is always explicit.
166166

167167
### Lazily started async
168168

@@ -219,7 +219,7 @@ So, here the two coroutines are defined but not executed as in the previous exam
219219
the programmer on when exactly to start the execution by calling [start][Job.start]. We first
220220
start `one`, then start `two`, and then await for the individual coroutines to finish.
221221

222-
Note, that if we have called [await][Deferred.await] in `println` and omitted [start][Job.start] on individual
222+
Note that if we have called [await][Deferred.await] in `println` and omitted [start][Job.start] on individual
223223
coroutines, then we would have got the sequential behaviour as [await][Deferred.await] starts the coroutine
224224
execution and waits for the execution to finish, which is not the intended use-case for laziness.
225225
The use-case for `async(start = CoroutineStart.LAZY)` is a replacement for the
@@ -249,7 +249,7 @@ fun somethingUsefulTwoAsync() = GlobalScope.async {
249249

250250
</div>
251251

252-
Note, that these `xxxAsync` functions are **not** _suspending_ functions. They can be used from anywhere.
252+
Note that these `xxxAsync` functions are **not** _suspending_ functions. They can be used from anywhere.
253253
However, their use always implies asynchronous (here meaning _concurrent_) execution of their action
254254
with the invoking code.
255255

@@ -264,7 +264,7 @@ import kotlinx.coroutines.*
264264
import kotlin.system.*
265265

266266
//sampleStart
267-
// note, that we don't have `runBlocking` to the right of `main` in this example
267+
// note that we don't have `runBlocking` to the right of `main` in this example
268268
fun main() {
269269
val time = measureTimeMillis {
270270
// we can initiate async actions outside of a coroutine

docs/coroutine-context-and-dispatchers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ same coroutine as you can see in the output below:
267267

268268
<!--- TEST -->
269269

270-
Note, that this example also uses `use` function from the Kotlin standard library to release threads that
270+
Note that this example also uses `use` function from the Kotlin standard library to release threads that
271271
are created with [newSingleThreadContext] when they are no longer needed.
272272

273273
### Job in the context
@@ -299,7 +299,7 @@ My job is "coroutine#1":BlockingCoroutine{Active}@6d311334
299299

300300
<!--- TEST lines.size == 1 && lines[0].startsWith("My job is \"coroutine#1\":BlockingCoroutine{Active}@") -->
301301

302-
Note, that [isActive] in [CoroutineScope] is just a convenient shortcut for
302+
Note that [isActive] in [CoroutineScope] is just a convenient shortcut for
303303
`coroutineContext[Job]?.isActive == true`.
304304

305305
### Children of a coroutine

docs/select-expression.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ fun CoroutineScope.asyncStringsList(): List<Deferred<String>> {
376376
</div>
377377

378378
Now the main function awaits for the first of them to complete and counts the number of deferred values
379-
that are still active. Note, that we've used here the fact that `select` expression is a Kotlin DSL,
379+
that are still active. Note that we've used here the fact that `select` expression is a Kotlin DSL,
380380
so we can provide clauses for it using an arbitrary code. In this case we iterate over a list
381381
of deferred values to provide `onAwait` clause for each deferred value.
382382

docs/shared-mutable-state-and-concurrency.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ works as a solution to the problem of shared mutable state. Indeed, actors may m
553553
Actor is more efficient than locking under load, because in this case it always has work to do and it does not
554554
have to switch to a different context at all.
555555

556-
> Note, that an [actor] coroutine builder is a dual of [produce] coroutine builder. An actor is associated
556+
> Note that an [actor] coroutine builder is a dual of [produce] coroutine builder. An actor is associated
557557
with the channel that it receives messages from, while a producer is associated with the channel that it
558558
sends elements to.
559559

integration/kotlinx-coroutines-guava/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ fun combineImagesAsync(name1: String, name2: String): ListenableFuture<Image> =
3535
}
3636
```
3737

38-
Note, that this module should be used only for integration with existing Java APIs based on `ListenableFuture`.
38+
Note that this module should be used only for integration with existing Java APIs based on `ListenableFuture`.
3939
Writing pure-Kotlin code that uses `ListenableFuture` is highly not recommended, since the resulting APIs based
4040
on the futures are quite error-prone. See the discussion on
4141
[Asynchronous Programming Styles](https://github.com/Kotlin/kotlin-coroutines/blob/master/kotlin-coroutines-informal.md#asynchronous-programming-styles)

integration/kotlinx-coroutines-jdk8/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ fun combineImagesAsync(name1: String, name2: String): CompletableFuture<Image> =
3636
}
3737
```
3838

39-
Note, that this module should be used only for integration with existing Java APIs based on `CompletableFuture`.
39+
Note that this module should be used only for integration with existing Java APIs based on `CompletableFuture`.
4040
Writing pure-Kotlin code that uses `CompletableFuture` is highly not recommended, since the resulting APIs based
4141
on the futures are quite error-prone. See the discussion on
4242
[Asynchronous Programming Styles](https://github.com/Kotlin/KEEP/blob/master/proposals/coroutines.md#asynchronous-programming-styles)

integration/kotlinx-coroutines-slf4j/src/MDCContext.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public typealias MDCContextMap = Map<String, String>?
2828
* }
2929
* ```
3030
*
31-
* Note, that you cannot update MDC context from inside of the coroutine simply
31+
* Note that you cannot update MDC context from inside of the coroutine simply
3232
* using [MDC.put]. These updates are going to be lost on the next suspension and
3333
* reinstalled to the MDC context that was captured or explicitly specified in
3434
* [contextMap] when this object was created on the next resumption.

kotlinx-coroutines-core/common/src/Await.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ private class AwaitAll<T>(private val deferreds: Array<out Deferred<T>>) {
109109
}
110110
} else if (notCompletedCount.decrementAndGet() == 0) {
111111
continuation.resume(deferreds.map { it.getCompleted() })
112-
// Note, that all deferreds are complete here, so we don't need to dispose their nodes
112+
// Note that all deferreds are complete here, so we don't need to dispose their nodes
113113
}
114114
}
115115
}

kotlinx-coroutines-core/common/src/Builders.common.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ private class LazyDeferredCoroutine<T>(
127127
*
128128
* This function uses dispatcher from the new context, shifting execution of the [block] into the
129129
* different thread if a new dispatcher is specified, and back to the original dispatcher
130-
* when it completes. Note, that the result of `withContext` invocation is
130+
* when it completes. Note that the result of `withContext` invocation is
131131
* dispatched into the original context in a cancellable way, which means that if the original [coroutineContext],
132132
* in which `withContext` was invoked, is cancelled by the time its dispatcher starts to execute the code,
133133
* it discards the result of `withContext` and throws [CancellationException].

kotlinx-coroutines-core/common/src/CompletableDeferred.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import kotlinx.coroutines.selects.*
1010
/**
1111
* A [Deferred] that can be completed via public functions [complete] or [cancel][Job.cancel].
1212
*
13-
* Note, that [complete] functions returns `false` when this deferred value is already complete or completing,
13+
* Note that [complete] functions returns `false` when this deferred value is already complete or completing,
1414
* while [cancel][Job.cancel] returns `true` as long the deferred is still _cancelling_ and the corresponding
1515
* exception is incorporated into the final [completion exception][getCompletionExceptionOrNull].
1616
*

kotlinx-coroutines-core/common/src/CoroutineStart.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public enum class CoroutineStart {
2626
* function as most dispatchers do, then the coroutine code is dispatched for execution later, while the code that
2727
* invoked the coroutine builder continues execution.
2828
*
29-
* Note, that [Dispatchers.Unconfined] always returns `false` from its [CoroutineDispatcher.isDispatchNeeded]
29+
* Note that [Dispatchers.Unconfined] always returns `false` from its [CoroutineDispatcher.isDispatchNeeded]
3030
* function, so starting coroutine with [Dispatchers.Unconfined] by [DEFAULT] is the same as using [UNDISPATCHED].
3131
*
3232
* If coroutine [Job] is cancelled before it even had a chance to start executing, then it will not start its

kotlinx-coroutines-core/common/src/Deferred.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import kotlinx.coroutines.selects.*
1616
* successful or failed result of the computation that was carried out. The result of the deferred is
1717
* available when it is [completed][isCompleted] and can be retrieved by [await] method, which throws
1818
* exception if the deferred had failed.
19-
* Note, that a _cancelled_ deferred is also considered to be completed.
19+
* Note that a _cancelled_ deferred is also considered to be completed.
2020
* The corresponding exception can be retrieved via [getCompletionExceptionOrNull] from a completed instance of deferred.
2121
*
2222
* Usually, a deferred value is created in _active_ state (it is created and started).

kotlinx-coroutines-core/common/src/Delay.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public interface Delay {
6363
* If the [Job] of the current coroutine is cancelled or completed while this suspending function is waiting, this function
6464
* immediately resumes with [CancellationException].
6565
*
66-
* Note, that delay can be used in [select] invocation with [onTimeout][SelectBuilder.onTimeout] clause.
66+
* Note that delay can be used in [select] invocation with [onTimeout][SelectBuilder.onTimeout] clause.
6767
*
6868
* Implementation note: how exactly time is tracked is an implementation detail of [CoroutineDispatcher] in the context.
6969
* @param timeMillis time in milliseconds.

kotlinx-coroutines-core/common/src/Dispatchers.common.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public expect object Dispatchers {
6666
* Can print both "1 2 3" and "1 3 2", this is an implementation detail that can be changed.
6767
* But it is guaranteed that "Done" will be printed only when both `withContext` are completed.
6868
*
69-
* Note, that if you need your coroutine to be confined to a particular thread or a thread-pool after resumption,
69+
* Note that if you need your coroutine to be confined to a particular thread or a thread-pool after resumption,
7070
* but still want to execute it in the current call-frame until its first suspension, then you can use
7171
* an optional [CoroutineStart] parameter in coroutine builders like
7272
* [launch][CoroutineScope.launch] and [async][CoroutineScope.async] setting it to the

kotlinx-coroutines-core/common/src/Job.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ import kotlin.jvm.*
6969
*
7070
* A job can have a _parent_ job. A job with a parent is cancelled when its parent is cancelled.
7171
* Parent job waits in _completing_ or _cancelling_ state for all its children to complete before finishing.
72-
* Note, that _completing_ state is purely internal to the job. For an outside observer a _completing_ job is still
72+
* Note that _completing_ state is purely internal to the job. For an outside observer a _completing_ job is still
7373
* active, while internally it is waiting for its children.
7474
*
7575
* Normal cancellation of a job is distinguished from its failure by the type of its cancellation exception cause.
@@ -190,7 +190,7 @@ public interface Job : CoroutineContext.Element {
190190
* * Parent cannot complete until all its children are complete. Parent waits for all its children to
191191
* complete in _completing_ or _cancelling_ state.
192192
* * Uncaught exception in a child, by default, cancels parent. In particular, this applies to
193-
* children created with [launch][CoroutineScope.launch] coroutine builder. Note, that
193+
* children created with [launch][CoroutineScope.launch] coroutine builder. Note that
194194
* [async][CoroutineScope.async] and other future-like
195195
* coroutine builders do not have uncaught exceptions by definition, since all their exceptions are
196196
* caught and are encapsulated in their result.
@@ -227,7 +227,7 @@ public interface Job : CoroutineContext.Element {
227227
* when the job is complete for any reason and the [Job] of the invoking coroutine is still [active][isActive].
228228
* This function also [starts][Job.start] the corresponding coroutine if the [Job] was still in _new_ state.
229229
*
230-
* Note, that the job becomes complete only when all its children are complete.
230+
* Note that the job becomes complete only when all its children are complete.
231231
*
232232
* This suspending function is cancellable and **always** checks for the cancellation of invoking coroutine's Job.
233233
* If the [Job] of the invoking coroutine is cancelled or completed when this

kotlinx-coroutines-core/common/src/JobSupport.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public open class JobSupport constructor(active: Boolean) : Job, ChildJob, Paren
8181
successfully without children (in this case it directly goes from EMPTY_A or SINGLE state to FINAL_R
8282
state without going to COMPLETING state)
8383
84-
Note, that the actual `_state` variable can also be a reference to atomic operation descriptor `OpDescriptor`
84+
Note that the actual `_state` variable can also be a reference to atomic operation descriptor `OpDescriptor`
8585
8686
---------- TIMELINE of state changes and notification in Job lifecycle ----------
8787
@@ -909,7 +909,7 @@ public open class JobSupport constructor(active: Boolean) : Job, ChildJob, Paren
909909

910910
/**
911911
* When this function returns `true` the parent is cancelled on cancellation of this job.
912-
* Note, that [CancellationException] is considered "normal" and parent is not cancelled when child produces it.
912+
* Note that [CancellationException] is considered "normal" and parent is not cancelled when child produces it.
913913
* This allows parent to cancel its children (normally) without being cancelled itself, unless
914914
* child crashes and produce some other exception during its completion.
915915
*

kotlinx-coroutines-core/common/src/Timeout.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import kotlin.jvm.*
1919
* cancellable suspending function inside the block throws [TimeoutCancellationException].
2020
*
2121
* The sibling function that does not throw exception on timeout is [withTimeoutOrNull].
22-
* Note, that timeout action can be specified for [select] invocation with [onTimeout][SelectBuilder.onTimeout] clause.
22+
* Note that timeout action can be specified for [select] invocation with [onTimeout][SelectBuilder.onTimeout] clause.
2323
*
2424
* Implementation note: how exactly time is tracked is an implementation detail of [CoroutineDispatcher] in the context.
2525
*
@@ -40,7 +40,7 @@ public suspend fun <T> withTimeout(timeMillis: Long, block: suspend CoroutineSco
4040
* cancellable suspending function inside the block throws [TimeoutCancellationException].
4141
*
4242
* The sibling function that throws exception on timeout is [withTimeout].
43-
* Note, that timeout action can be specified for [select] invocation with [onTimeout][SelectBuilder.onTimeout] clause.
43+
* Note that timeout action can be specified for [select] invocation with [onTimeout][SelectBuilder.onTimeout] clause.
4444
*
4545
* Implementation note: how exactly time is tracked is an implementation detail of [CoroutineDispatcher] in the context.
4646
*

0 commit comments

Comments
 (0)