From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 10 Oct 2022 01:02:49 +0000 (-0700)
Subject: Fix types in buffer/memoryview docs (GH-98118)
X-Git-Tag: v3.10.8~8
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=03ea515f33b3073d2c680b5a7786ea603076eb6d;p=thirdparty%2FPython%2Fcpython.git

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>
---

diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index e32719373cc7..e3b49472991a 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 24f8c935302e..94ee8123e575 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