summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/source/reference/c-api.types-and-structures.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/source/reference/c-api.types-and-structures.rst b/doc/source/reference/c-api.types-and-structures.rst
index 79a888912..d26ed56cb 100644
--- a/doc/source/reference/c-api.types-and-structures.rst
+++ b/doc/source/reference/c-api.types-and-structures.rst
@@ -466,10 +466,10 @@ PyArrayDescr_Type
A pointer to a function that compares two elements of the
array, ``arr``, pointed to by ``d1`` and ``d2``. This
- function requires behaved arrays. The return value is 1 if *
- ``d1`` > * ``d2``, 0 if * ``d1`` == * ``d2``, and -1 if *
- ``d1`` < * ``d2``. The array object arr is used to retrieve
- itemsize and field information for flexible arrays.
+ function requires behaved (aligned and not swapped) arrays.
+ The return value is 1 if * ``d1`` > * ``d2``, 0 if * ``d1`` == *
+ ``d2``, and -1 if * ``d1`` < * ``d2``. The array object ``arr`` is
+ used to retrieve itemsize and field information for flexible arrays.
.. cmember:: int argmax(void* data, npy_intp n, npy_intp* max_ind,
void* arr)