From 2c7dee96caae06ba85c752d193b176e69fae701d Mon Sep 17 00:00:00 2001 From: "John T. Wodder II" Date: Sun, 20 Feb 2022 13:03:20 -0500 Subject: [PATCH] Docs tweaks --- README.rst | 6 +++--- src/interleave/__init__.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 210e9c4..2c68585 100644 --- a/README.rst +++ b/README.rst @@ -133,7 +133,7 @@ iterators after the initial exception are discarded. .. code:: python - class Interleaver(Generic[T]) + class Interleaver(Generic[T]): def __init__( self, max_workers: Optional[int] = None, @@ -149,7 +149,7 @@ on exit, cleans up any unfinished threads by calling the ``shutdown(wait=True)`` method (see below). An ``Interleaver`` can be instantiated either by calling ``interleave()`` or by -using the constructor directly. The constructor takes the same arguments as +calling the constructor directly. The constructor takes the same arguments as ``interleave()``, minus ``iterators``, and produces a new ``Interleaver`` that is not yet running any iterators. Iterators are submitted to a new ``Interleaver`` via the ``submit()`` method; once all desired iterators have @@ -171,7 +171,7 @@ following public methods: .. code:: python - Interleaver.submit(it: Iterator[T]) -> None: + Interleaver.submit(it: Iterator[T]) -> None *New in version 0.2.0* diff --git a/src/interleave/__init__.py b/src/interleave/__init__.py index 49a0dce..30f076d 100644 --- a/src/interleave/__init__.py +++ b/src/interleave/__init__.py @@ -234,7 +234,7 @@ class Interleaver(Generic[T]): ``shutdown(wait=True)`` method (see below). An `Interleaver` can be instantiated either by calling `interleave()` or by - using the constructor directly. The constructor takes the same arguments + calling the constructor directly. The constructor takes the same arguments as `interleave()`, minus ``iterators``, and produces a new `Interleaver` that is not yet running any iterators. Iterators are submitted to a new `Interleaver` via the `submit()` method; once all desired iterators have