Added documentation for lengthCompare, fixed ta...

Added documentation for lengthCompare, fixed tail recursive method.

1 files changed, 5 insertions, 2 deletions

diff --git a/src/library/scala/Stream.scala b/src/library/scala/Stream.scala
index f22e76bcbb..07213cba8e 100644
--- a/src/library/scala/Stream.scala
+++ b/src/library/scala/Stream.scala
@@ -237,9 +237,12 @@ trait Stream[+A] extends Seq.Projection[A] {
     len
   }
 
-  /** returns length - l without calling length
+  /** Returns
+   *   - (length - l) if l >= length
+   *   - 1 otherwise
+   *  This method does not call Stream.length.
    */
-  override def lengthCompare(l: Int) = {
+  final override def lengthCompare(l: Int) = {
     if (isEmpty) 0 - l
     else if (l <= 0) 1
     else tail.lengthCompare(l - 1)