Skip to content

Commit

Permalink
Docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
jwodder committed Feb 20, 2022
1 parent df5738a commit 2c7dee9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
Expand All @@ -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*

Expand Down
2 changes: 1 addition & 1 deletion src/interleave/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2c7dee9

Please sign in to comment.