diff options
author | BartekJanota <bartosz.janota@sigmapoint.co> | 2015-02-03 14:17:04 +0100 |
---|---|---|
committer | BartekJanota <bartosz.janota@sigmapoint.co> | 2015-02-04 12:30:04 +0100 |
commit | 720ce5d7a111a8e5dcd380f0abe3a972a75392be (patch) | |
tree | 0a5341d984b739dc826f2243ce9c7ce431f30ac5 /src/library/scala/collection/IterableLike.scala | |
parent | 5d7098c629bbb7cc0ab7e74c235bd4afca3de24e (diff) | |
download | scala-720ce5d7a111a8e5dcd380f0abe3a972a75392be.tar.gz scala-720ce5d7a111a8e5dcd380f0abe3a972a75392be.tar.bz2 scala-720ce5d7a111a8e5dcd380f0abe3a972a75392be.zip |
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.
Diffstat (limited to 'src/library/scala/collection/IterableLike.scala')
-rw-r--r-- | src/library/scala/collection/IterableLike.scala | 3 |
1 files changed, 2 insertions, 1 deletions
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. |