summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorda-woods <dw-git@d-woods.co.uk>2022-10-10 00:55:53 (GMT)
committerGitHub <noreply@github.com>2022-10-10 00:55:53 (GMT)
commitc459fedf7cfd5dadf72e088d789c7375b3a6e093 (patch)
tree9545909c733def41b8058ce1f249379d0cb2ecb3
parent281a3f18cc2afac0fa92c75e807775971e531711 (diff)
downloadcpython-c459fedf7cfd5dadf72e088d789c7375b3a6e093.zip
cpython-c459fedf7cfd5dadf72e088d789c7375b3a6e093.tar.gz
cpython-c459fedf7cfd5dadf72e088d789c7375b3a6e093.tar.bz2
Fix types in buffer/memoryview docs (#98118)
The definition of obj in the `Py_buffer` struct is as a PyObject* https://github.com/python/cpython/blob/ec091bd47e2f968b0d1631b9a8104283a7beeb1b/Include/pybuffer.h#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`
-rw-r--r--Doc/c-api/buffer.rst2
-rw-r--r--Doc/c-api/memoryview.rst2
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