diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-10-10 01:03:53 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-10 01:03:53 (GMT) |
commit | 4172e09c3a93f95874cccd3d008e9d036472d859 (patch) | |
tree | 214d68716dd6a3bea01388edbdf757947930b279 /Doc/c-api | |
parent | 6211bb2cf876a05c7b77239d4af39039b0459b8e (diff) | |
download | cpython-4172e09c3a93f95874cccd3d008e9d036472d859.zip cpython-4172e09c3a93f95874cccd3d008e9d036472d859.tar.gz cpython-4172e09c3a93f95874cccd3d008e9d036472d859.tar.bz2 |
Fix types in buffer/memoryview docs (GH-98118)
The definition of obj in the `Py_buffer` struct is as a PyObject*
https://github.com/python/cpython/blob/ec091bd47e2f968b0d1631b9a8104283a7beeb1b/Include/pybuffer.hGH-L22
PyMemoryView_GET_BASE returns `.obj` - thus its return type
should be a PyObject* (or at least a void*). It definitely
doesn't return `Py_buffer`
(cherry picked from commit c459fedf7cfd5dadf72e088d789c7375b3a6e093)
Co-authored-by: da-woods <dw-git@d-woods.co.uk>
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/buffer.rst | 2 | ||||
-rw-r--r-- | Doc/c-api/memoryview.rst | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst index 05e131d..a04062f 100644 --- a/Doc/c-api/buffer.rst +++ b/Doc/c-api/buffer.rst @@ -99,7 +99,7 @@ a buffer, see :c:func:`PyObject_GetBuffer`. For :term:`contiguous` arrays, the value points to the beginning of the memory block. - .. c:member:: void *obj + .. c:member:: PyObject *obj A new reference to the exporting object. The reference is owned by the consumer and automatically decremented and set to ``NULL`` by diff --git a/Doc/c-api/memoryview.rst b/Doc/c-api/memoryview.rst index 4d94b3f..ebd5c77 100644 --- a/Doc/c-api/memoryview.rst +++ b/Doc/c-api/memoryview.rst @@ -55,7 +55,7 @@ any other object. *mview* **must** be a memoryview instance; this macro doesn't check its type, you must do it yourself or you will risk crashes. -.. c:function:: Py_buffer *PyMemoryView_GET_BASE(PyObject *mview) +.. c:function:: PyObject *PyMemoryView_GET_BASE(PyObject *mview) Return either a pointer to the exporting object that the memoryview is based on or ``NULL`` if the memoryview has been created by one of the functions |