Correct some documentation typos (#167)

cashapp · Nov 3, 2022 · 3867298 · 3867298
1 parent f91b176
commit 3867298
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/commonMain/kotlin/app/cash/turbine/ReceiveTurbine.kt b/src/commonMain/kotlin/app/cash/turbine/ReceiveTurbine.kt
@@ -73,7 +73,7 @@ public interface ReceiveTurbine<T> {
    * Assert that an event was received and return it.
    * This function will suspend if no events have been received.
    *
-   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error], this method
+   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error]), this method
    * will yield the same result every time it is called.
    */
   public suspend fun awaitEvent(): Event<T>
@@ -82,7 +82,7 @@ public interface ReceiveTurbine<T> {
    * Assert that the next event received was an item and return it.
    * This function will suspend if no events have been received.
    *
-   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error], this method
+   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error]), this method
    * will yield the same result every time it is called.
    *
    * @throws AssertionError if the next event was completion or an error.
@@ -101,7 +101,7 @@ public interface ReceiveTurbine<T> {
    * Assert that the next event received was the flow completing.
    * This function will suspend if no events have been received.
    *
-   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error], this method
+   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error]), this method
    * will yield the same result every time it is called.
    *
    * @throws AssertionError if the next event was an item or an error.
@@ -112,7 +112,7 @@ public interface ReceiveTurbine<T> {
    * Assert that the next event received was an error terminating the flow.
    * This function will suspend if no events have been received.
    *
-   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error], this method
+   * When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error]), this method
    * will yield the same result every time it is called.
    *
    * @throws AssertionError if the next event was an item or completion.