Skip to content

Commit bac0f5e

Browse files
committed
add some more Scaladoc
1 parent c8f6731 commit bac0f5e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/main/scala/scala/collection/immutable/next/package.scala

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ package object next {
2424
*
2525
* Safe to call on unbounded input, but in that case the result is not a cycle
2626
* (not even if the input was).
27+
*
28+
* Note that some `LazyList` methods preserve cyclicality and others do not.
29+
* So for example the `tail` of a cycle is still a cycle, but `map` and `filter`
30+
* on a cycle do not return cycles.
2731
*/
2832
def cycle: LazyList[T] =
2933
// case 1: the input is already known to be empty

0 commit comments

Comments
 (0)