diff options
| author | A. Jesse Jiryu Davis <jesse@mongodb.com> | 2017-01-24 14:11:00 -0500 |
|---|---|---|
| committer | A. Jesse Jiryu Davis <jesse@mongodb.com> | 2017-01-24 14:11:00 -0500 |
| commit | 63abc8114060e9d11eaf339a58362e00c8d59c66 (patch) | |
| tree | 0829cd7c56944a86833e5bea2d0aede5f903e159 /doc/source/reference/c-api.array.rst | |
| parent | f737b354e6ab2aef8b4c05bca0011de46a4b53b0 (diff) | |
| download | numpy-63abc8114060e9d11eaf339a58362e00c8d59c66.tar.gz | |
DOC: fix return value for PyArray_Resize
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst index 3574282a4..2a7bb3a32 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -1686,12 +1686,12 @@ Shape Manipulation different total number of elements then the old shape. If reallocation is necessary, then *self* must own its data, have *self* - ``>base==NULL``, have *self* - ``>weakrefs==NULL``, and - (unless refcheck is 0) not be referenced by any other array. A - reference to the new array is returned. The fortran argument can - be :c:data:`NPY_ANYORDER`, :c:data:`NPY_CORDER`, or - :c:data:`NPY_FORTRANORDER`. It currently has no effect. Eventually + (unless refcheck is 0) not be referenced by any other array. + The fortran argument can be :c:data:`NPY_ANYORDER`, :c:data:`NPY_CORDER`, + or :c:data:`NPY_FORTRANORDER`. It currently has no effect. Eventually it could be used to determine how the resize operation should view the data when constructing a differently-dimensioned array. + Returns None on success and NULL on error. .. c:function:: PyObject* PyArray_Transpose(PyArrayObject* self, PyArray_Dims* permute) |