summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.array.rst
diff options
context:
space:
mode:
authorKriti Singh <kritisingh1.ks@gmail.com>2019-07-01 00:56:58 +0530
committerSebastian Berg <sebastian@sipsolutions.net>2019-06-30 12:26:58 -0700
commitb4105bf03f16e0bd38c6a74ba32de5b0a69ed190 (patch)
treee18369baddc8896a2b2ae2ab522ae084aceae0c6 /doc/source/reference/c-api.array.rst
parent2131c6b14d092587c29c55e999e2bddc47f1382d (diff)
downloadnumpy-b4105bf03f16e0bd38c6a74ba32de5b0a69ed190.tar.gz
DOC: Add missing macros to C-API documentation (#13825)
* DOC: Adds missing macros in C-API documentation * Adds new PyUFunc_{KIND} macros Fixes #13775
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
-rw-r--r--doc/source/reference/c-api.array.rst18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index bd6062b16..39f936414 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -3466,6 +3466,10 @@ Other constants
The maximum number of dimensions allowed in arrays.
+.. c:var:: NPY_MAXARGS
+
+ The maximum number of array arguments that can be used in functions.
+
.. c:var:: NPY_VERSION
The current version of the ndarray object (check to see if this
@@ -3558,10 +3562,18 @@ Enumerated Types
.. c:type:: NPY_SORTKIND
- A special variable-type which can take on the values :c:data:`NPY_{KIND}`
- where ``{KIND}`` is
+ A special variable-type which can take on different values to indicate
+ the sorting algorithm being used.
+
+ .. c:var:: NPY_QUICKSORT
+
+ .. c:var:: NPY_HEAPSORT
+
+ .. c:var:: NPY_MERGESORT
+
+ .. c:var:: NPY_STABLESORT
- **QUICKSORT**, **HEAPSORT**, **MERGESORT**, **STABLESORT**
+ Used as an alias of :c:data:`NPY_MERGESORT` and vica versa.
.. c:var:: NPY_NSORTS