From: Hai Shi <shihai1992@gmail.com>
Date: Wed, 31 Jul 2019 14:48:15 +0000 (-0500)
Subject: bpo-34101: Add doc of PyBuffer_GetPointer (GH-14994)
X-Git-Tag: v3.9.0a1~939
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1b29af83bc17e773b0c0d117f5fe1018fde46b0d;p=thirdparty%2FPython%2Fcpython.git

bpo-34101: Add doc of PyBuffer_GetPointer (GH-14994)
---

diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 7553efc2cfbc..fdb8bd19d218 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -475,6 +475,12 @@ Buffer-related functions
    (*order* is ``'A'``).  Return ``0`` otherwise.  This function always succeeds.
 
 
+.. c:function:: void* PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
+
+   Get the memory area pointed to by the *indices* inside the given *view*.
+   *indices* must point to an array of ``view->ndim`` indices.
+
+
 .. c:function:: int PyBuffer_ToContiguous(void *buf, Py_buffer *src, Py_ssize_t len, char order)
 
    Copy *len* bytes from *src* to its contiguous representation in *buf*.