diff options
| author | Matti Picus <matti.picus@gmail.com> | 2021-10-27 23:09:51 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-27 15:09:51 -0500 |
| commit | aebf38662647b328e5ac10c52a24202b3a22cf66 (patch) | |
| tree | 50e6ad54c9bb64b42b18c67a29f719ae1c5ceb21 /doc/source/reference/c-api/array.rst | |
| parent | f66a76ec2d592c4f44c3f44c596b6d6f581626e5 (diff) | |
| download | numpy-aebf38662647b328e5ac10c52a24202b3a22cf66.tar.gz | |
MAINT: Only warn for transferred ownership if env variable is set (#20200)
Builds on gh-20194. Fixes breakage of SciPy in https://github.com/scipy/scipy/issues/14917
At some point we could flip the default to "warn" instead of "no warning"
* make warning conditional on NUMPY_WARN_IF_NO_MEM_POLICY
* add test, fix example code
* fixes from review
* typo
Diffstat (limited to 'doc/source/reference/c-api/array.rst')
| -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 6a135fd71..232690486 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -325,8 +325,7 @@ From scratch should be increased after the pointer is passed in, and the base member of the returned ndarray should point to the Python object that owns the data. This will ensure that the provided memory is not - freed while the returned array is in existence. To free memory as soon - as the ndarray is deallocated, set the OWNDATA flag on the returned ndarray. + freed while the returned array is in existence. .. c:function:: PyObject* PyArray_SimpleNewFromDescr( \ int nd, npy_int const* dims, PyArray_Descr* descr) @@ -1463,7 +1462,9 @@ of the constant names is deprecated in 1.7. .. c:macro:: NPY_ARRAY_OWNDATA - The data area is owned by this array. + The data area is owned by this array. Should never be set manually, instead + create a ``PyObject`` wrapping the data and set the array's base to that + object. For an example, see the test in ``test_mem_policy``. .. c:macro:: NPY_ARRAY_ALIGNED |