Permalink
Browse files

* fixes 1234 - Update documentation of Box's equals method

  • Loading branch information...
1 parent 48d3b80 commit bf35da80ce5cb654d6740ea4b33746a0cfed1551 @fmpwizard fmpwizard committed Jun 22, 2012
Showing with 9 additions and 0 deletions.
  1. +9 −0 core/common/src/main/scala/net/liftweb/common/Box.scala
@@ -404,6 +404,15 @@ sealed abstract class Box[+A] extends Product {
/**
* Determines equality based upon the contents of this Box instead of the box itself.
+ * As a result, it is not symmetric. Which means that for
+ *
+ * <pre name="code" class="scala">
+ * val foo = "foo"
+ * val boxedFoo = Full(foo)
+ * foo == boxedFoo //is false
+ * boxedFoo == foo //is true
+ * </pre>
+ *
* For Full and Empty, this has the expected behavior. Equality in terms of Failure
* checks for equivalence of failure causes.
*/

0 comments on commit bf35da8

Please sign in to comment.