Merge pull request #472 from more-itertools/version-8.6.0

Version 8.6.0
more-itertools · Oct 30, 2020 · 4d2e1db · 4d2e1db
2 parents 16c626b + a8d3959
commit 4d2e1db
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 12 deletions.
diff --git a/README.rst b/README.rst
@@ -34,6 +34,7 @@ Python iterables.
 |                        | `substrings <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.substrings>`_,                                                                                                                  |
 |                        | `substrings_indexes <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.substrings_indexes>`_,                                                                                                  |
 |                        | `stagger <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.stagger>`_,                                                                                                                        |
+|                        | `windowed_complete <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.windowed_complete>`_,                                                                                                    |
 |                        | `pairwise <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.pairwise>`_                                                                                                                       |
 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Augmenting             | `count_cycle <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.count_cycle>`_,                                                                                                                |
@@ -97,6 +98,8 @@ Python iterables.
 |                        | `random_permutation <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.random_permutation>`_,                                                                                                  |
 |                        | `random_combination <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.random_combination>`_,                                                                                                  |
 |                        | `random_combination_with_replacement <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.random_combination_with_replacement>`_,                                                                |
+|                        | `nth_product <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.nth_product>`_                                                                                                                 |
+|                        | `nth_permutation <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.nth_permutation>`_                                                                                                         |
 |                        | `nth_combination <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.nth_combination>`_                                                                                                         |
 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Wrapping               | `always_iterable <https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable>`_,                                                                                                        |

diff --git a/docs/api.rst b/docs/api.rst
@@ -209,8 +209,9 @@ These tools yield combinatorial arrangements of items from iterables.
 .. autofunction:: random_permutation
 .. autofunction:: random_combination
 .. autofunction:: random_combination_with_replacement
-.. autofunction:: nth_combination
+.. autofunction:: nth_product
 .. autofunction:: nth_permutation
+.. autofunction:: nth_combination
 
 
 Wrapping

diff --git a/docs/versions.rst b/docs/versions.rst
@@ -5,9 +5,23 @@ Version History
 .. automodule:: more_itertools
    :noindex:
 
-8.5.0
+8.6.0
 -----
 
+* New itertools
+    * :func:`all_unique` (thanks to brianmaissy)
+    * :func:`nth_product` and :func:`nth_permutation` (thanks to N8Brooks)
+
+* Changes to existing itertools
+    * :func:`chunked` and :func:`sliced` now accept a ``strict`` parameter (thanks to shlomif and jtwool)
+
+* Other changes
+    * Python 3.5 has reached its end of life and is no longer supported.
+    * Python 3.9 is officially supported.
+    * Various documentation fixes (thanks to timgates42)
+
+8.5.0
+-----
 
 * New itertools
     * :func:`windowed_complete` (thanks to MarcinKonowalczyk)

diff --git a/more_itertools/__init__.py b/more_itertools/__init__.py
@@ -1,4 +1,4 @@
 from .more import *  # noqa
 from .recipes import *  # noqa
 
-__version__ = '8.5.0'
+__version__ = '8.6.0'
diff --git a/more_itertools/more.py b/more_itertools/more.py
@@ -3431,10 +3431,11 @@ def windowed_complete(iterable, n):
     (0, 1, 2) (3, 4, 5) (6,)
     (0, 1, 2, 3) (4, 5, 6) ()
 
-    Notes:
-       * *n* must be at least 0 and most equal to the length of *iterable*.
-       * This function will exhaust *iterable* and store all its items.
+    Note that *n* must be at least 0 and most equal to the length of
+    *iterable*.
 
+    This function will exhaust the iterable and may require significant
+    storage.
     """
     if n < 0:
         raise ValueError('n must be >= 0')
@@ -3457,11 +3458,11 @@ def all_unique(iterable, key=None):
     Returns ``True`` if all the elements of *iterable* are unique (no two
     elements are equal).
 
-    If a *key* function is specified, it will be used to preprocess the
-    elements of the iterable before comparing.
-
         >>> all_unique('ABCB')
         False
+
+    If a *key* function is specified, it will be used to make comparisons.
+
         >>> all_unique('ABCb')
         True
         >>> all_unique('ABCb', str.lower)
@@ -3489,7 +3490,8 @@ def all_unique(iterable, key=None):
 
 def nth_product(index, *args):
     """Equivalent to ``list(product(*args))[index]``.
-    The products of **args* can be ordered lexicographically.
+
+    The products of *args* can be ordered lexicographically.
     :func:`nth_product` computes the product at sort position *index* without
     computing the previous products.
     """

diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 8.5.0
+current_version = 8.6.0
 commit = True
 tag = False
 files = more_itertools/__init__.py

diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py{36,37,38}
+envlist = py{36,37,38,39}
 
 [testenv]
 commands = {envpython} -m unittest -v {posargs}