docs(Either): isEmpty / isNotEmpty docs (#2550)

arrow-kt · Oct 25, 2021 · df850ee · df850ee
1 parent 0538a86
commit df850ee
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/Either.kt b/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/Either.kt
@@ -949,8 +949,26 @@ public sealed class Either<out A, out B> {
   public inline fun all(predicate: (B) -> Boolean): Boolean =
     fold({ true }, predicate)
 
+  /**
+   * Returns `true` if [Left]
+   *
+   * Example:
+   * ```
+   * Left("foo").isEmpty()  // Result: true
+   * Right("foo").isEmpty() // Result: false
+   * ```
+   */
   public fun isEmpty(): Boolean = isLeft
 
+  /**
+   * Returns `true` if [Right]
+   *
+   * Example:
+   * ```
+   * Left("foo").isEmpty()  // Result: false
+   * Right("foo").isEmpty() // Result: true
+   * ```
+   */
   public fun isNotEmpty(): Boolean = isRight
 
   /**