Merge pull request #12418 from liwt31/timsort-dev

ENH: Add timsort to npysort

1 files changed, 9 insertions, 0 deletions

diff --git a/doc/release/1.17.0-notes.rst b/doc/release/1.17.0-notes.rst
index d15936cb6..ab09f85bd 100644
--- a/doc/release/1.17.0-notes.rst
+++ b/doc/release/1.17.0-notes.rst
@@ -54,6 +54,15 @@ identity, it is necessary to also pass in an initial value (e.g.,
 ``initial=np.inf`` for ``np.min``).  For instance, the equivalent of
 ``nansum`` would be, ``np.sum(a, where=~np.isnan(a))``.
 
+Timsort is added to available sorting algorithms and is now the default stable sort
+-----------------------------------------------------------------------------------
+The ``kind`` keyword argument for ``sort`` and ``argsort`` now accepts ``'t'``
+or ``'timsort'`` for Timsort. The ``stable`` option of ``kind`` argument is now
+mapped to Timsort. Timsort features great performace
+on already or nearly sorted data and resembles Mergesort on random data.
+The algorithm is stable and requires O(n/2) additional space.
+For details of the algorithm, refer to
+`CPython listsort.txt <https://github.com/python/cpython/blob/3.7/Objects/listsort.txt>`_.
 
 ``np.linalg.svd`` and ``np.linalg.pinv`` can be faster on hermitian inputs
 --------------------------------------------------------------------------