diff options
| author | yuki <drsuaimqjgar@gmail.com> | 2023-04-07 03:57:02 +0000 |
|---|---|---|
| committer | yuki <drsuaimqjgar@gmail.com> | 2023-04-07 10:41:16 +0000 |
| commit | 5e57c084a519fd3731c6ac1056481ff2730cd738 (patch) | |
| tree | 8a7695affa8ea3648a6eac50fb1afa7739d8898f /doc/source/reference/c-api | |
| parent | 5e5ed9c4a50554dd71bcdac9227e3e57661e7705 (diff) | |
| download | numpy-5e57c084a519fd3731c6ac1056481ff2730cd738.tar.gz | |
DOC: Fix description of `PyArray_DiscardWritebackIfCopy`
If my understanding of this document is correct,
`PyArray_DiscardWritebackIfCopy` should be replaced with
`PyArray_ResolveWritebackIfCopy`.
Diffstat (limited to 'doc/source/reference/c-api')
| -rw-r--r-- | doc/source/reference/c-api/array.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index 9abaaddf5..79f5e32dc 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -3586,7 +3586,7 @@ Miscellaneous Macros If ``obj->flags`` has :c:data:`NPY_ARRAY_WRITEBACKIFCOPY`, this function clears the flags, `DECREF` s `obj->base` and makes it writeable, and sets ``obj->base`` to NULL. In - contrast to :c:func:`PyArray_DiscardWritebackIfCopy` it makes no attempt + contrast to :c:func:`PyArray_ResolveWritebackIfCopy` it makes no attempt to copy the data from `obj->base` This undoes :c:func:`PyArray_SetWritebackIfCopyBase`. Usually this is called after an error when you are finished with ``obj``, just before ``Py_DECREF(obj)``. |