Update toSingleBox doc to state that List sizes may differ.

lift · Apr 8, 2014 · 1d2cf14 · 1d2cf14
1 parent 2b93d76
commit 1d2cf14
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/core/common/src/main/scala/net/liftweb/common/Box.scala b/core/common/src/main/scala/net/liftweb/common/Box.scala
@@ -40,6 +40,10 @@ case class ListOfBoxes[T](theListOfBoxes: List[Box[T]]) {
    * a Failure, a ParamFailure is returned, containing the original List[Box[T]] as the
    * param.
    *
+   * It is worth noting that the size of the list in the resulting Box[List[T]] may not be equal
+   * to the size of the List[Box[T]] that is fed as Empty values will disappear altogether in the
+   * conversion.
+   *
    * @param failureErrorMessage The string that should be placed in the message for the Failure.
    * @return A Full[List[T]] if no Failures were present. ParamFailure[List[Box[T]]] otherwise.
   **/