Update docs.
authorScott Gasch <[email protected]>
Wed, 6 Jul 2022 16:58:12 +0000 (09:58 -0700)
committerScott Gasch <[email protected]>
Wed, 6 Jul 2022 16:58:12 +0000 (09:58 -0700)
iter_utils.py

index 8cd204dacfb407ad846761fb0edcee43906cff30..c6daddfc2ea3116ff32761076171a8a8f3d19944 100644 (file)
@@ -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__()