search

ACMNexus / google-collections

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

Example in javadoc for Iterators.peekingIterator confusing #127

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago 
The sample source fragment in the javadoc for the method 
Iterators.peekingIterator has the following (Java) comment:

// Either the next three calls will each throw
// NoSuchElementExceptions, or...

It's confusing because if the first of the following calls to peek() throws 
NoSuchElementException, the following two calls to peek() won't be reached. 
A simple rewording of the comment would fix this, e.g.,

// Either the first call to peek() will throw 
// NoSuchElementException, or...

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

GoogleCodeExporter commented 8 years ago 
Thanks, next code drop will have wholly rewritten doc for this method and 
interface,
which I hope will address your concern and others.

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