Update kotlinx-coroutines-core/common/src/flow/SharedFlow.kt

elizarov · 1zaman · elizarov · commit 6566e1e3f784 · 2020-07-07T20:22:20.000+03:00
Co-authored-by: Ibraheem Zaman &lt;1zaman@users.noreply.github.com&gt;
diff --git a/kotlinx-coroutines-core/common/src/CompletableDeferred.kt b/kotlinx-coroutines-core/common/src/CompletableDeferred.kt
@@ -19,7 +19,7 @@ import kotlinx.coroutines.selects.*
  * All functions on this interface are **thread-safe** and can
  * be safely invoked from concurrent coroutines without external synchronization.
  *
- * **`CompletableDeferred` interface is not stable for inheritance in 3rd party libraries**,
+ * **The `CompletableDeferred` interface is not stable for inheritance in 3rd party libraries**,
  * as new methods might be added to this interface in the future, but is stable for use.
  */
 public interface CompletableDeferred<T> : Deferred<T> {
diff --git a/kotlinx-coroutines-core/common/src/CompletableJob.kt b/kotlinx-coroutines-core/common/src/CompletableJob.kt
@@ -11,7 +11,7 @@ package kotlinx.coroutines
  * All functions on this interface are **thread-safe** and can
  * be safely invoked from concurrent coroutines without external synchronization.
  *
- * **`CompletableJob` interface is not stable for inheritance in 3rd party libraries**,
+ * **The `CompletableJob` interface is not stable for inheritance in 3rd party libraries**,
  * as new methods might be added to this interface in the future, but is stable for use.
  */
 public interface CompletableJob : Job {
diff --git a/kotlinx-coroutines-core/common/src/flow/Flow.kt b/kotlinx-coroutines-core/common/src/flow/Flow.kt
@@ -161,9 +161,9 @@ import kotlin.coroutines.*
  *
  * ### Not stable for inheritance
  *
- * **`Flow` interface is not stable for inheritance in 3rd party libraries**, as new methods
+ * **The `Flow` interface is not stable for inheritance in 3rd party libraries**, as new methods
  * might be added to this interface in the future, but is stable for use.
- * Use `flow { ... }` builder function to create an implementation.
+ * Use the `flow { ... }` builder function to create an implementation.
  */
 public interface Flow<out T> {
     /**
diff --git a/kotlinx-coroutines-core/common/src/flow/SharedFlow.kt b/kotlinx-coroutines-core/common/src/flow/SharedFlow.kt
@@ -104,7 +104,7 @@ import kotlin.native.concurrent.*
  *
  * ### Not stable for inheritance
  *
- * **`SharedFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
+ * **The `SharedFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
  * might be added to this interface in the future, but is stable for use.
  * Use the `MutableSharedFlow(replay, ...)` constructor function to create an implementation.
  */
@@ -134,9 +134,9 @@ public interface SharedFlow<out T> : Flow<T> {
  *
  * ### Not stable for inheritance
  *
- * **`MutableSharedFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
+ * **The `MutableSharedFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
  * might be added to this interface in the future, but is stable for use.
- * Use `MutableSharedFlow(...)` constructor function to create an implementation.
+ * Use the `MutableSharedFlow(...)` constructor function to create an implementation.
  */
 @ExperimentalCoroutinesApi
 public interface MutableSharedFlow<T> : SharedFlow<T>, FlowCollector<T> {
diff --git a/kotlinx-coroutines-core/common/src/flow/StateFlow.kt b/kotlinx-coroutines-core/common/src/flow/StateFlow.kt
@@ -131,9 +131,9 @@ import kotlin.native.concurrent.*
  *
  * ### Not stable for inheritance
  *
- * **`StateFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
+ * **`The StateFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
  * might be added to this interface in the future, but is stable for use.
- * Use `MutableStateFlow(value)` constructor function to create an implementation.
+ * Use the `MutableStateFlow(value)` constructor function to create an implementation.
  */
 @ExperimentalCoroutinesApi
 public interface StateFlow<out T> : SharedFlow<T> {
@@ -152,9 +152,9 @@ public interface StateFlow<out T> : SharedFlow<T> {
  *
  * ### Not stable for inheritance
  *
- * **`MutableStateFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
+ * **The `MutableStateFlow` interface is not stable for inheritance in 3rd party libraries**, as new methods
  * might be added to this interface in the future, but is stable for use.
- * Use `MutableStateFlow()` constructor function to create an implementation.
+ * Use the `MutableStateFlow()` constructor function to create an implementation.
  */
 @ExperimentalCoroutinesApi
 public interface MutableStateFlow<T> : StateFlow<T>, MutableSharedFlow<T> {

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ import kotlinx.coroutines.selects.*`
`19`	`19`	`* All functions on this interface are thread-safe and can`
`20`	`20`	`* be safely invoked from concurrent coroutines without external synchronization.`
`21`	`21`	`*`
`22`		- * `CompletableDeferred` interface is not stable for inheritance in 3rd party libraries,
	`22`	+ * The `CompletableDeferred` interface is not stable for inheritance in 3rd party libraries,
`23`	`23`	`* as new methods might be added to this interface in the future, but is stable for use.`
`24`	`24`	`*/`
`25`	`25`	`public interface CompletableDeferred<T> : Deferred<T> {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ package kotlinx.coroutines`
`11`	`11`	`* All functions on this interface are thread-safe and can`
`12`	`12`	`* be safely invoked from concurrent coroutines without external synchronization.`
`13`	`13`	`*`
`14`		- * `CompletableJob` interface is not stable for inheritance in 3rd party libraries,
	`14`	+ * The `CompletableJob` interface is not stable for inheritance in 3rd party libraries,
`15`	`15`	`* as new methods might be added to this interface in the future, but is stable for use.`
`16`	`16`	`*/`
`17`	`17`	`public interface CompletableJob : Job {`
Original file line number	Diff line number	Diff line change
`@@ -161,9 +161,9 @@ import kotlin.coroutines.*`
`161`	`161`	`*`
`162`	`162`	`* ### Not stable for inheritance`
`163`	`163`	`*`
`164`		- * `Flow` interface is not stable for inheritance in 3rd party libraries, as new methods
	`164`	+ * The `Flow` interface is not stable for inheritance in 3rd party libraries, as new methods
`165`	`165`	`* might be added to this interface in the future, but is stable for use.`
`166`		- * Use `flow { ... }` builder function to create an implementation.
	`166`	+ * Use the `flow { ... }` builder function to create an implementation.
`167`	`167`	`*/`
`168`	`168`	`public interface Flow<out T> {`
`169`	`169`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ import kotlin.native.concurrent.*`
`104`	`104`	`*`
`105`	`105`	`* ### Not stable for inheritance`
`106`	`106`	`*`
`107`		- * `SharedFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
	`107`	+ * The `SharedFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
`108`	`108`	`* might be added to this interface in the future, but is stable for use.`
`109`	`109`	* Use the `MutableSharedFlow(replay, ...)` constructor function to create an implementation.
`110`	`110`	`*/`
`@@ -134,9 +134,9 @@ public interface SharedFlow<out T> : Flow<T> {`
`134`	`134`	`*`
`135`	`135`	`* ### Not stable for inheritance`
`136`	`136`	`*`
`137`		- * `MutableSharedFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
	`137`	+ * The `MutableSharedFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
`138`	`138`	`* might be added to this interface in the future, but is stable for use.`
`139`		- * Use `MutableSharedFlow(...)` constructor function to create an implementation.
	`139`	+ * Use the `MutableSharedFlow(...)` constructor function to create an implementation.
`140`	`140`	`*/`
`141`	`141`	`@ExperimentalCoroutinesApi`
`142`	`142`	`public interface MutableSharedFlow<T> : SharedFlow<T>, FlowCollector<T> {`
Original file line number	Diff line number	Diff line change
`@@ -131,9 +131,9 @@ import kotlin.native.concurrent.*`
`131`	`131`	`*`
`132`	`132`	`* ### Not stable for inheritance`
`133`	`133`	`*`
`134`		- * `StateFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
	`134`	+ * `The StateFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
`135`	`135`	`* might be added to this interface in the future, but is stable for use.`
`136`		- * Use `MutableStateFlow(value)` constructor function to create an implementation.
	`136`	+ * Use the `MutableStateFlow(value)` constructor function to create an implementation.
`137`	`137`	`*/`
`138`	`138`	`@ExperimentalCoroutinesApi`
`139`	`139`	`public interface StateFlow<out T> : SharedFlow<T> {`
`@@ -152,9 +152,9 @@ public interface StateFlow<out T> : SharedFlow<T> {`
`152`	`152`	`*`
`153`	`153`	`* ### Not stable for inheritance`
`154`	`154`	`*`
`155`		- * `MutableStateFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
	`155`	+ * The `MutableStateFlow` interface is not stable for inheritance in 3rd party libraries, as new methods
`156`	`156`	`* might be added to this interface in the future, but is stable for use.`
`157`		- * Use `MutableStateFlow()` constructor function to create an implementation.
	`157`	+ * Use the `MutableStateFlow()` constructor function to create an implementation.
`158`	`158`	`*/`
`159`	`159`	`@ExperimentalCoroutinesApi`
`160`	`160`	`public interface MutableStateFlow<T> : StateFlow<T>, MutableSharedFlow<T> {`