franklinblanco/kotlin-result
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typo in throwIf/throwUnless kdoc

Browse Source 
Missed the word "returns".
This commit is contained in:
Michael Bull 2021-10-26 17:09:58 +01:00
parent 653bc90ffa
commit 6080f3f190
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Or.kt
View File

@ -107,8 +107,8 @@ public inline fun <V, E> Result<V, E>.recoverUnless(predicate: (E) -> Boolean, t
} }
/** /**
* Throws the [error][Err.error] if this [Result] is an [Err] * Throws the [error][Err.error] if this [Result] is an [Err] and satisfies the given
* and satisfies the given [predicate], otherwise this [Result]. * [predicate], otherwise returns this [Result].
* *
* @see [takeIf] * @see [takeIf]
*/ */
@ -128,8 +128,8 @@ public inline fun <V, E : Throwable> Result<V, E>.throwIf(predicate: (E) -> Bool
} }
/** /**
* Throws the [error][Err.error] if this [Result] is an [Err] * Throws the [error][Err.error] if this [Result] is an [Err] and _does not_ satisfy the
* and _does not_ satisfy the given [predicate], otherwise this [Result]. * given [predicate], otherwise returns this [Result].
* *
* @see [takeUnless] * @see [takeUnless]
*/ */