Merge pull request #10586 from som-snytt/doc/either-filter

Highlight Either#toOption for filtering
scala · Oct 30, 2023 · 41b9d37 · 41b9d37
2 parents a557e93 + 7f59e85
commit 41b9d37
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/library/scala/util/Either.scala b/src/library/scala/util/Either.scala
@@ -85,6 +85,14 @@ package util
  *  // Similarly, refutable patterns are not supported:
  *  for (x: Int <- right1) yield x
  *  // error: value withFilter is not a member of Right[Double,Int]
+ *
+ *  // To use a filtered value, convert to an Option first,
+ *  // which drops the Left case, as None contains no value:
+ *  for {
+ *    i <- right1.toOption
+ *    if i > 0
+ *  } yield i
+ *
  *  }}}
  *
  *  Since `for` comprehensions use `map` and `flatMap`, the types