summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian Taylor <jtaylor.debian@googlemail.com>2014-06-11 21:11:06 +0200
committerJulian Taylor <jtaylor.debian@googlemail.com>2014-06-11 21:36:31 +0200
commit118dc9e46f4534cfedefa1c253bb4ecd868061d1 (patch)
tree5161ffed17c04c9a7923910d1cdb83513fbac256
parent6ec8a1d43737371b5a0899fa33067aff67422640 (diff)
downloadnumpy-118dc9e46f4534cfedefa1c253bb4ecd868061d1.tar.gz
DOC: fix signature of PyArray_NewShape in C-API docs
closes gh-4579
-rw-r--r--doc/source/reference/c-api.array.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index 23355bc91..baf804378 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -1632,11 +1632,11 @@ Conversion
Shape Manipulation
^^^^^^^^^^^^^^^^^^
-.. cfunction:: PyObject* PyArray_Newshape(PyArrayObject* self, PyArray_Dims* newshape)
+.. cfunction:: PyObject* PyArray_Newshape(PyArrayObject* self, PyArray_Dims* newshape, NPY_ORDER order)
Result will be a new array (pointing to the same memory location
- as *self* if possible), but having a shape given by *newshape*
- . If the new shape is not compatible with the strides of *self*,
+ as *self* if possible), but having a shape given by *newshape*.
+ If the new shape is not compatible with the strides of *self*,
then a copy of the array with the new specified shape will be
returned.
@@ -1645,6 +1645,7 @@ Shape Manipulation
Equivalent to :meth:`ndarray.reshape` (*self*, *shape*) where *shape* is a
sequence. Converts *shape* to a :ctype:`PyArray_Dims` structure and
calls :cfunc:`PyArray_Newshape` internally.
+ For back-ward compatability -- Not recommended
.. cfunction:: PyObject* PyArray_Squeeze(PyArrayObject* self)