Skip to content

Commit

Permalink
docstring updates: fix zip_longest -> enumerate
Browse files Browse the repository at this point in the history
  • Loading branch information
olirice committed Apr 25, 2023
1 parent 326e563 commit 462c00d
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions src/flupy/fluent.py
Expand Up @@ -6,12 +6,9 @@
from itertools import dropwhile, groupby, islice, product, takewhile, tee, zip_longest
from random import sample
from typing import (
TYPE_CHECKING,
Any,
Callable,
Collection,
Container,
ContextManager,
Deque,
Generator,
Generic,
Expand All @@ -20,7 +17,6 @@
Iterator,
List,
Optional,
Sequence,
Set,
Tuple,
Type,
Expand Down Expand Up @@ -546,7 +542,7 @@ def zip(
"Fluent[Tuple[T, _T1, _T2, _T3]]",
]:
"""Yields tuples containing the i-th element from the i-th
argument in the chainable, and the iterable
argument in the instance, and the iterable
>>> flu(range(5)).zip(range(3, 0, -1)).to_list()
[(0, 3), (1, 2), (2, 1)]
Expand All @@ -558,7 +554,7 @@ def zip(

def zip_longest(self, *iterable: Iterable[_T1], fill_value: Any = None) -> "Fluent[Tuple[T, ...]]":
"""Yields tuples containing the i-th element from the i-th
argument in the chainable, and the iterable
argument in the instance, and the iterable
Iteration continues until the longest iterable is exhaused.
If iterables are uneven in length, missing values are filled in with fill value
Expand All @@ -572,11 +568,11 @@ def zip_longest(self, *iterable: Iterable[_T1], fill_value: Any = None) -> "Flue
return Fluent(zip_longest(self, *iterable, fillvalue=fill_value))

def enumerate(self, start: int = 0) -> "Fluent[Tuple[int, T]]":
"""Yields tuples from the chainable where the first element
"""Yields tuples from the instance where the first element
is a count from initial value *start*.
>>> flu(range(5)).zip_longest(range(3, 0, -1)).to_list()
[(0, 3), (1, 2), (2, 1), (3, None), (4, None)]
>>> flu([3,4,5]).enumerate().to_list()
[(0, 3), (1, 4), (2, 5)]
"""
return Fluent(enumerate(self, start=start))

Expand Down

0 comments on commit 462c00d

Please sign in to comment.