diff options
| author | mattip <matti.picus@gmail.com> | 2017-11-11 21:13:04 +0200 |
|---|---|---|
| committer | mattip <matti.picus@gmail.com> | 2017-11-11 21:13:04 +0200 |
| commit | 88f78abbbd26f3e5d3b220c1b8af50cbeb512a55 (patch) | |
| tree | 0ec3dacd97d5a2402c9dc5229bd478c5a1a8da78 /doc/source/reference/c-api.array.rst | |
| parent | 642975935f2a2c3e79209607c7d16ef41eff2d7f (diff) | |
| download | numpy-88f78abbbd26f3e5d3b220c1b8af50cbeb512a55.tar.gz | |
DOC: reword PyArray_DiscardWritebackIfCopy description
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 d3aa7cafb..343bbc29c 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -3471,10 +3471,11 @@ Miscellaneous Macros .. c:function:: PyArray_DiscardWritebackIfCopy(PyObject* obj) Reset the :c:data:`NPY_ARRAY_WRITEBACKIFCOPY` and deprecated - :c:data:`NPY_ARRAY_UPDATEIFCOPY` flag. Also resets the - :c:data:`NPY_ARRAY_WRITEABLE` flag on the base object. This is + :c:data:`NPY_ARRAY_UPDATEIFCOPY` flag. Resets the + :c:data:`NPY_ARRAY_WRITEABLE` flag on the base object. It also + deletes pending changes to the base object. This is useful for recovering from an error condition when - writeback semantics are used, but will lead to wrong results. + writeback semantics are used. .. c:function:: PyArray_XDECREF_ERR(PyObject* obj) |