From 720ce5d7a111a8e5dcd380f0abe3a972a75392be Mon Sep 17 00:00:00 2001 From: BartekJanota Date: Tue, 3 Feb 2015 14:17:04 +0100 Subject: Scala doc update (sliding method). Added info about default step set to 1. Reading this doc (having no code) can be ambiguous. updated scala doc (overloaded sliding method) Step is a method parameter and must be always given explicit, so info about default value is wrong. --- src/library/scala/collection/IterableLike.scala | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src/library') diff --git a/src/library/scala/collection/IterableLike.scala b/src/library/scala/collection/IterableLike.scala index 91ab1f6ac2..7643b84a8b 100644 --- a/src/library/scala/collection/IterableLike.scala +++ b/src/library/scala/collection/IterableLike.scala @@ -179,6 +179,7 @@ self => /** Groups elements in fixed size blocks by passing a "sliding window" * over them (as opposed to partitioning them, as is done in grouped.) + * "Sliding window" step is 1 by default. * @see [[scala.collection.Iterator]], method `sliding` * * @param size the number of elements per group @@ -194,7 +195,7 @@ self => * * @param size the number of elements per group * @param step the distance between the first elements of successive - * groups (defaults to 1) + * groups * @return An iterator producing ${coll}s of size `size`, except the * last and the only element will be truncated if there are * fewer elements than size. -- cgit v1.2.3