From 850d18476daee764fc28dc0d07106b1291e161c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Wed, 11 Oct 2023 11:20:36 +0200 Subject: [PATCH] Mention ignoreErrors in nullable's documentation --- .../src/commonMain/kotlin/arrow/core/raise/Builders.kt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Builders.kt b/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Builders.kt index 3acfc9fdaae..5d2e0d4cec0 100644 --- a/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Builders.kt +++ b/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Builders.kt @@ -42,6 +42,9 @@ public inline fun either(@BuilderInference block: Raise.() -> * * Read more about running a [Raise] computation in the * [Arrow docs](https://arrow-kt.io/learn/typed-errors/working-with-typed-errors/#running-and-inspecting-results). + * + * @see NullableRaise.ignoreErrors By default, `nullable` only allows raising `null`. + * Calling [ignoreErrors][NullableRaise.ignoreErrors] inside `nullable` allows to raise any error, which will be returned to the caller as if `null` was raised. */ public inline fun nullable(block: NullableRaise.() -> A): A? = merge { block(NullableRaise(this)) }