diff options
author | mattip <matti.picus@gmail.com> | 2017-12-05 01:04:34 +0200 |
---|---|---|
committer | mattip <matti.picus@gmail.com> | 2017-12-05 01:04:34 +0200 |
commit | 92fadf484a291134c6a54879c40fef04d6568af7 (patch) | |
tree | 4b419e2a1e52529b759be014a3cdf02cf1442a2c /doc/release | |
parent | 63b884e3756ef148629dd175f948a6c3d8e80f0b (diff) | |
download | python-numpy-92fadf484a291134c6a54879c40fef04d6568af7.tar.gz python-numpy-92fadf484a291134c6a54879c40fef04d6568af7.tar.bz2 python-numpy-92fadf484a291134c6a54879c40fef04d6568af7.zip |
tweak docs to reflect exactly when DeprecationWarnings will be displayed
Diffstat (limited to 'doc/release')
-rw-r--r-- | doc/release/1.14.0-notes.rst | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/release/1.14.0-notes.rst b/doc/release/1.14.0-notes.rst index 60ffd2048..6c46600cb 100644 --- a/doc/release/1.14.0-notes.rst +++ b/doc/release/1.14.0-notes.rst @@ -259,7 +259,8 @@ writeback to the original array occurs at ndarray deallocation. For explicitly called before deallocation (or, if an error occurred, ``PyArray_DiscardWritebackIfCopy``). Numpy now mostly uses the ``WRITEBACKIFCOPY`` mechanism internally, but still uses ``UPDATEIFCOPY`` in -nditer use for backward-compatibility with the python nditer interface. +nditer use for backward-compatibility with the python nditer interface which +has not changed. In python code, if numpy is compiled with ``-DDEPRECATE_UPDATEIFCOPY`` or if run on PyPy, ``DeprecationWarning`` warnings will be issued on use of @@ -267,14 +268,14 @@ run on PyPy, ``DeprecationWarning`` warnings will be issued on use of occurred before calling ``array_dealloc``. In the future this warning will always be issued, once nditer stops using ``UPDATEIFCOPY``. -In C code, calling ``PyArray_SetUpdateIfCopyBase`` will now always issue a -``DeprecationWarning`` and should be replaced by -``PyArray_SetWritebackIfCopyBase``. Similarly, calls to ``PyArray_XDECREF_ERR`` -should be replaced by ``PyArray_DiscardWritebackIfCopy``. Calling ndarray -creation functions such as ``PyArray_FromArray`` where flags uses -``NPY_ARRAY_UPDATEIFCOPY`` will also raise a ``DeprecationWarning``. In all -these cases the code must be further modified to call -``PyArray_ResolveWritebackIfCopy`` before deallocation. +In C code, ``PyArray_SetUpdateIfCopyBase`` should be replaced by +``PyArray_SetWritebackIfCopyBase``. Until nditer user is updated, this call +will not emit a ``DeprecationWarning``. Calls to ``PyArray_XDECREF_ERR`` +should be replaced by ``PyArray_DiscardWritebackIfCopy`` and will emit a +``DeprectaionWarning``. Calling ndarray creation functions such as +``PyArray_FromArray`` where flags uses ``NPY_ARRAY_UPDATEIFCOPY`` will raise a +``DeprecationWarning``. In all these cases the code must be further modified to +call ``PyArray_ResolveWritebackIfCopy`` before deallocation. Note that during the deprecation period, the ``NPY_ARRAY_INOUT_ARRAY`` and ``NPY_ARRAY_INOUT_FARRAY`` flags should be replaced by |