Merge pull request #31 from olirice/or/docstrings-5

Docstring updates: fix zip_longest -> enumerate

.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
         matrix:
-            python-version: ['3.6', '3.7', '3.8', '3.9']
+            python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
 
     steps:
 

README.md

@@ -2,7 +2,6 @@
 
 <p>
 
-<a href="https://github.com/olirice/flupy/actions"><img src="https://github.com/olirice/flupy/workflows/Tests/badge.svg" alt="Tests" height="18"></a>
 <a href="https://flupy.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/flupy/badge/?version=latest" alt="Tests" height="18"></a>
 <a href="https://codecov.io/gh/olirice/flupy"><img src="https://codecov.io/gh/olirice/flupy/branch/master/graph/badge.svg" height="18"></a>
 <a href="https://github.com/psf/black">

src/flupy/fluent.py

@@ -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,
@@ -20,7 +17,6 @@
     Iterator,
     List,
     Optional,
-    Sequence,
     Set,
     Tuple,
     Type,
@@ -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)]
@@ -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
 
@@ -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))