diff options
| author | Scott Gasch <[email protected]> | 2022-07-06 09:58:12 -0700 |
|---|---|---|
| committer | Scott Gasch <[email protected]> | 2022-07-06 09:58:12 -0700 |
| commit | 1803c7b2af8fde615b81ac21a6dc56e56dc20594 (patch) | |
| tree | 4f800710f07fdeaad7ea5f5767e9140ef66178e7 /iter_utils.py | |
| parent | e106f3e4aa1e038cd52ea966a961c2493ab56096 (diff) | |
Update docs.
Diffstat (limited to 'iter_utils.py')
| -rw-r--r-- | iter_utils.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/iter_utils.py b/iter_utils.py index 8cd204d..c6daddf 100644 --- a/iter_utils.py +++ b/iter_utils.py @@ -17,9 +17,9 @@ from typing import Any, List, Optional class PeekingIterator(Iterator): - """An iterator that lets you peek() at the next item on deck. + """An iterator that lets you :meth:`peek` at the next item on deck. Returns None when there is no next item (i.e. when - __next__() will produce a StopIteration exception). + :meth:`__next__` will produce a StopIteration exception). >>> p = PeekingIterator(iter(range(3))) >>> p.__next__() |