summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.array.rst
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2016-10-17 16:57:40 -0600
committerCharles Harris <charlesr.harris@gmail.com>2016-10-17 17:11:06 -0600
commit155ee365c56f519e150ccfe5c29ef19b0a51f1ca (patch)
treec5be0d332e8c34be9e7c4711c0873387817439da /doc/source/reference/c-api.array.rst
parent811c90567c136bc77cc1343f3ec61b4534d22be5 (diff)
downloadnumpy-155ee365c56f519e150ccfe5c29ef19b0a51f1ca.tar.gz
DOC: Further fixes for PyArray_{Max, Min, Ptp} documentation.
[ci skip]
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
-rw-r--r--doc/source/reference/c-api.array.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index 12841a312..3574282a4 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -1919,20 +1919,24 @@ Calculation
.. c:function:: PyObject* PyArray_Max(PyArrayObject* self, int axis, PyArrayObject* out)
- Equivalent to :meth:`ndarray.max` (*self*, *axis*). Return the largest
- element of *self* along the given *axis*.
- If it return only 1 element, return a numpy scalar, not an ndarray.
+ Equivalent to :meth:`ndarray.max` (*self*, *axis*). Returns the largest
+ element of *self* along the given *axis*. When the result is a single
+ element, returns a numpy scalar instead of an ndarray.
.. c:function:: PyObject* PyArray_Min(PyArrayObject* self, int axis, PyArrayObject* out)
Equivalent to :meth:`ndarray.min` (*self*, *axis*). Return the smallest
- element of *self* along the given *axis*.
+ element of *self* along the given *axis*. When the result is a single
+ element, returns a numpy scalar instead of an ndarray.
+
.. c:function:: PyObject* PyArray_Ptp(PyArrayObject* self, int axis, PyArrayObject* out)
Equivalent to :meth:`ndarray.ptp` (*self*, *axis*). Return the difference
between the largest element of *self* along *axis* and the
- smallest element of *self* along *axis*.
+ smallest element of *self* along *axis*. When the result is a single
+ element, returns a numpy scalar instead of an ndarray.
+