From 3867298c38a70698bed3deda7efe65a7f038768b Mon Sep 17 00:00:00 2001 From: Bill Phillips Date: Thu, 3 Nov 2022 09:52:23 -0700 Subject: [PATCH] Correct some documentation typos (#167) --- src/commonMain/kotlin/app/cash/turbine/ReceiveTurbine.kt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/commonMain/kotlin/app/cash/turbine/ReceiveTurbine.kt b/src/commonMain/kotlin/app/cash/turbine/ReceiveTurbine.kt index ee4d9a18..c312d099 100644 --- 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 { * 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 @@ -82,7 +82,7 @@ public interface ReceiveTurbine { * 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 { * 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 { * 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.