Commit 44cd9a8e authored by Eric Myhre's avatar Eric Myhre

Merge branch 'more-doc-fix'

parents a388f744 8569c0a4
...@@ -108,10 +108,10 @@ type MapIterator interface { ...@@ -108,10 +108,10 @@ type MapIterator interface {
// Done returns false as long as there's at least one more entry to iterate. // Done returns false as long as there's at least one more entry to iterate.
// When Done returns true, iteration can stop. // When Done returns true, iteration can stop.
// //
// Implementers of iterators for advanced data layouts (e.g. more than // Note when implementing iterators for advanced data layouts (e.g. more than
// one chunk of backing data, which is loaded incrementally), if your // one chunk of backing data, which is loaded incrementally): if your
// implementation does any I/O during the Done method, and it encounters // implementation does any I/O during the Done method, and it encounters
// an error, it must return 'true', so that the following Next call // an error, it must return 'false', so that the following Next call
// has an opportunity to return the error. // has an opportunity to return the error.
Done() bool Done() bool
} }
...@@ -136,10 +136,10 @@ type ListIterator interface { ...@@ -136,10 +136,10 @@ type ListIterator interface {
// Done returns false as long as there's at least one more entry to iterate. // Done returns false as long as there's at least one more entry to iterate.
// When Done returns false, iteration can stop. // When Done returns false, iteration can stop.
// //
// Implementers of iterators for advanced data layouts (e.g. more than // Note when implementing iterators for advanced data layouts (e.g. more than
// one chunk of backing data, which is loaded incrementally), if your // one chunk of backing data, which is loaded incrementally): if your
// implementation does any I/O during the Done method, and it encounters // implementation does any I/O during the Done method, and it encounters
// an error, it must return 'true', so that the following Next call // an error, it must return 'false', so that the following Next call
// has an opportunity to return the error. // has an opportunity to return the error.
Done() bool Done() bool
} }
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment