ACMNexus / google-collections

Automatically exported from code.google.com/p/google-collections
Apache License 2.0
0 stars 0 forks source link

Potentially confusing superfluous doc in Iterators.partition and .paddedPartition #129

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
The javadoc for the methods Iterators.partition and 
Iterators.paddedPartition includes this sentence:

  The iterator does not support the Iterator.remove() method.

This is confusing because the return type is UnmodifiableIterator (which by 
definition does not support remove()), so it it makes the reader wonder 
whether the sentence is referring to the returned iterator at all.

Simplest fix would be to remove the sentence entirely.

Original issue reported on code.google.com by tpeie...@gmail.com on 11 Mar 2009 at 7:01

GoogleCodeExporter commented 8 years ago
I agree, will fix.

I appreciate these suggestions very much.

Original comment by kevin...@gmail.com on 11 Mar 2009 at 8:18

GoogleCodeExporter commented 8 years ago
Then I'll keep callin' em' as I sees 'em. :-)

Original comment by tpeie...@gmail.com on 11 Mar 2009 at 8:45

GoogleCodeExporter commented 8 years ago
it'll be gone in the next code drop.

Original comment by kevin...@gmail.com on 18 Mar 2009 at 2:18