From: Scott Gasch Date: Wed, 6 Jul 2022 16:58:12 +0000 (-0700) Subject: Update docs. X-Git-Url: https://wannabe.guru.org/gitweb/?a=commitdiff_plain;h=1803c7b2af8fde615b81ac21a6dc56e56dc20594;p=python_utils.git Update docs. --- 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__()