From 6080f3f190fb6c9d841c1f42215fa8a12b56ffee Mon Sep 17 00:00:00 2001 From: Michael Bull Date: Tue, 26 Oct 2021 17:09:58 +0100 Subject: [PATCH] Fix typo in throwIf/throwUnless kdoc Missed the word "returns". --- .../commonMain/kotlin/com/github/michaelbull/result/Or.kt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Or.kt b/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Or.kt index 619be28..e61116b 100644 --- a/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Or.kt +++ b/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Or.kt @@ -107,8 +107,8 @@ public inline fun Result.recoverUnless(predicate: (E) -> Boolean, t } /** - * Throws the [error][Err.error] if this [Result] is an [Err] - * and satisfies the given [predicate], otherwise this [Result]. + * Throws the [error][Err.error] if this [Result] is an [Err] and satisfies the given + * [predicate], otherwise returns this [Result]. * * @see [takeIf] */ @@ -128,8 +128,8 @@ public inline fun Result.throwIf(predicate: (E) -> Bool } /** - * Throws the [error][Err.error] if this [Result] is an [Err] - * and _does not_ satisfy the given [predicate], otherwise this [Result]. + * Throws the [error][Err.error] if this [Result] is an [Err] and _does not_ satisfy the + * given [predicate], otherwise returns this [Result]. * * @see [takeUnless] */