diff options
| author | Piyush Jaipuriayar <piyushjaipuriyar@gmail.com> | 2019-01-15 10:51:05 +0530 |
|---|---|---|
| committer | Matti Picus <matti.picus@gmail.com> | 2019-01-15 07:21:05 +0200 |
| commit | f7d4688af45976e7d79c21bb5bdcc4ab6cee7a90 (patch) | |
| tree | 58ecade1e55009b0b2249f9afc26ab91717418d7 /doc/source/reference/c-api.array.rst | |
| parent | a4b450ddd71f6fc7efd1a1eff655122abaec2bdc (diff) | |
| download | numpy-f7d4688af45976e7d79c21bb5bdcc4ab6cee7a90.tar.gz | |
DOC: Document NPY_SORTKIND parameter in PyArray_Sort (#12606)
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst index 205483f14..7c298e118 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -1904,10 +1904,10 @@ Item selection and manipulation all values are clipped to the region [0, len(*op*) ). -.. c:function:: PyObject* PyArray_Sort(PyArrayObject* self, int axis) +.. c:function:: PyObject* PyArray_Sort(PyArrayObject* self, int axis, NPY_SORTKIND kind) - Equivalent to :meth:`ndarray.sort<numpy.ndarray.sort>` (*self*, *axis*). Return an array with - the items of *self* sorted along *axis*. + Equivalent to :meth:`ndarray.sort<numpy.ndarray.sort>` (*self*, *axis*, *kind*). Return an array with + the items of *self* sorted along *axis*.Array is sorted according to *kind* which is an integer/enum pointing to the type of sorting algorithms used. .. c:function:: PyObject* PyArray_ArgSort(PyArrayObject* self, int axis) |