Skip to content
Snippets Groups Projects
Unverified Commit 03ea515f authored by Miss Islington (bot)'s avatar Miss Islington (bot) Committed by GitHub
Browse files

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

Co-authored-by: default avatarda-woods <dw-git@d-woods.co.uk>
parent ccb56804
Branches
Tags
No related merge requests found
...@@ -99,7 +99,7 @@ a buffer, see :c:func:`PyObject_GetBuffer`. ...@@ -99,7 +99,7 @@ a buffer, see :c:func:`PyObject_GetBuffer`.
For :term:`contiguous` arrays, the value points to the beginning of For :term:`contiguous` arrays, the value points to the beginning of
the memory block. the memory block.
.. c:member:: void *obj .. c:member:: PyObject *obj
A new reference to the exporting object. The reference is owned by A new reference to the exporting object. The reference is owned by
the consumer and automatically decremented and set to ``NULL`` by the consumer and automatically decremented and set to ``NULL`` by
......
...@@ -55,7 +55,7 @@ any other object. ...@@ -55,7 +55,7 @@ any other object.
*mview* **must** be a memoryview instance; this macro doesn't check its type, *mview* **must** be a memoryview instance; this macro doesn't check its type,
you must do it yourself or you will risk crashes. 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 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 on or ``NULL`` if the memoryview has been created by one of the functions
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment