Merge pull request #501 from more-itertools/version-8.7.0

Version 8.7.0

docs/versions.rst

@@ -5,6 +5,26 @@ Version History
 .. automodule:: more_itertools
    :noindex:
 
+8.7.0
+-----
+
+* New functions
+    * :func:`convolve` (from the Python itertools docs)
+    * :func:`product_index`, :func:`combination_index`, and :func:`permutation_index` (thanks to N8Brooks)
+    * :func:`value_chain` (thanks to jenstroeger)
+
+* Changes to existing functions
+    * :func:`distinct_combinations` now uses a non-recursive algorithm (thanks to  knutdrand)
+    * :func:`pad_none` is now the preferred name for :func:`padnone`, though the latter remains available.
+    * :func:`pairwise` will now use the Python standard library implementation on Python 3.10+
+    * :func:`sort_together` now accepts a ``key`` argument (thanks to brianmaissy)
+    * :func:`seekable` now has a ``peek`` method, and can indicate whether the iterator it's wrapping is exhausted (thanks to gsakkis)
+    * :func:`time_limited` can now indicate whether its iterator has expired (thanks to roysmith)
+    * The implementation of :func:`unique_everseen` was improved (thanks to plammens)
+
+* Other changes:
+    * Various documentation updates (thanks to cthoyt, Evantm, and cyphase)
+
 8.6.0
 -----
 

more_itertools/__init__.py

@@ -1,4 +1,4 @@
 from .more import *  # noqa
 from .recipes import *  # noqa
 
-__version__ = '8.6.0'
+__version__ = '8.7.0'

more_itertools/more.py

@@ -3735,7 +3735,7 @@ def combination_index(element, iterable):
         10
 
     ``ValueError`` will be raised if the given *element* isn't one of the
-    combinations of *args*.
+    combinations of *iterable*.
     """
     element = enumerate(element)
     k, y = next(element, (None, None))
@@ -3779,7 +3779,7 @@ def permutation_index(element, iterable):
         19
 
     ``ValueError`` will be raised if the given *element* isn't one of the
-    permutations of *args*.
+    permutations of *iterable*.
     """
     index = 0
     pool = list(iterable)

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 8.6.0
+current_version = 8.7.0
 commit = True
 tag = False
 files = more_itertools/__init__.py