diff options
| author | Mads R. B. Kristensen <madsbk@gmail.com> | 2018-01-14 17:35:47 +0100 |
|---|---|---|
| committer | Mads R. B. Kristensen <madsbk@gmail.com> | 2018-01-14 17:35:47 +0100 |
| commit | f566d9e29db0b522a2278e34837ad9d3d02808d5 (patch) | |
| tree | db7ff0f7cde2be767165559e3f9cde9ae36b94a2 /doc | |
| parent | 354ac25c5815cc80f4d377b951f8d6d8d74a2ee9 (diff) | |
| download | python-numpy-f566d9e29db0b522a2278e34837ad9d3d02808d5.tar.gz python-numpy-f566d9e29db0b522a2278e34837ad9d3d02808d5.tar.bz2 python-numpy-f566d9e29db0b522a2278e34837ad9d3d02808d5.zip | |
DOC: added "steals a reference" to PyArray_FromAny
PyArray_FromAny() steals a reference to the dtype argument
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 7 |
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 82cac676e..ad7c725a8 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -382,10 +382,11 @@ From other objects sequence, or object that exposes the array interface, *op*. The parameters allow specification of the required *dtype*, the minimum (*min_depth*) and maximum (*max_depth*) number of - dimensions acceptable, and other *requirements* for the array. The - *dtype* argument needs to be a :c:type:`PyArray_Descr` structure + dimensions acceptable, and other *requirements* for the array. This + function **steals a reference** to the dtype argument, which needs + to be a :c:type:`PyArray_Descr` structure indicating the desired data-type (including required - byteorder). The *dtype* argument may be NULL, indicating that any + byteorder). The *dtype* argument may be ``NULL``, indicating that any data-type (and byteorder) is acceptable. Unless :c:data:`NPY_ARRAY_FORCECAST` is present in ``flags``, this call will generate an error if the data |