diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2019-02-08 17:45:28 -0700 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2019-02-08 17:45:28 -0700 |
| commit | 107e45b82021ba04f651f0ef89aa2f419d404d64 (patch) | |
| tree | bb3b703b40de42e9fde20369d6a67680cf2e5dbe /numpy/core/fromnumeric.py | |
| parent | d3eb626ef41e1302631b5154037567b9cc02630d (diff) | |
| download | numpy-107e45b82021ba04f651f0ef89aa2f419d404d64.tar.gz | |
DOC: Update sorting documention.
Update the sorting documentation to reflect the reality that 'mergesort'
and 'stable' are aliases and may refer to any of several stable sorting
algorithms depending on data type.
[ci skip]
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index acfe92a63..cdb6c4bed 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -831,12 +831,11 @@ def sort(a, axis=-1, kind='quicksort', order=None): kind : {'quicksort', 'mergesort', 'heapsort', 'stable'}, optional Sorting algorithm. The default is 'quicksort'. Note that both 'stable' and 'mergesort' use timsort under the covers and, in general, the - actual implementation will vary with datatype. The 'mergesort' option + actual implementation will vary with data type. The 'mergesort' option is retained for backwards compatibility. - .. versionchanged:: 1.17.0. - The 'stable' option was added together with stable sorting - algorithms other than 'mergesort'. + .. versionchanged:: 1.15.0. + The 'stable' option was added. order : str or list of str, optional When `a` is an array with fields defined, this argument specifies @@ -985,12 +984,12 @@ def argsort(a, axis=-1, kind='quicksort', order=None): kind : {'quicksort', 'mergesort', 'heapsort', 'stable'}, optional Sorting algorithm. The default is 'quicksort'. Note that both 'stable' and 'mergesort' use timsort under the covers and, in general, the - actual implementation will vary with datatype. The 'mergesort' option + actual implementation will vary with data type. The 'mergesort' option is retained for backwards compatibility. - .. versionchanged:: 1.17.0. - The 'stable' option was added together with stable sorting - algorithms other than 'mergesort'. + .. versionchanged:: 1.15.0. + The 'stable' option was added. + order : str or list of str, optional When `a` is an array with fields defined, this argument specifies |