From: Scott Gasch <scott@gasch.org>
Date: Tue, 5 Jul 2022 18:49:54 +0000 (-0700)
Subject: Update docs.
X-Git-Url: https://wannabe.guru.org/gitweb/?a=commitdiff_plain;h=562a15c6397610cf93646d9530005eb4a0d6e6f8;p=python_utils.git

Update docs.
---

diff --git a/iter_utils.py b/iter_utils.py
index 85c2749..69f5822 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 :method:`peek` at the next item on deck.
+    """An iterator that lets you peek() at the next item on deck.
     Returns None when there is no next item (i.e. when
-    :method:`__next__` will produce a StopIteration exception).
+    __next__() will produce a StopIteration exception).
 
     >>> p = PeekingIterator(iter(range(3)))
     >>> p.__next__()
@@ -113,11 +113,13 @@ class SamplingIterator(Iterator):
     collects a random sample (of size sample_size) of the stream that can
     be queried at any time.
 
-    Note that until sample_size elements have been seen the sample will
-    be less than sample_size elements in length.
+    .. note::
+        Until sample_size elements have been seen the sample will be
+        less than sample_size elements in length.
 
-    Note that if sample_size is > len(source_iter) then it will produce
-    a copy of source_iter.
+    .. note::
+        If sample_size is > len(source_iter) then it will produce a
+        copy of source_iter.
 
     >>> import collections
     >>> import random