[Python-checkins] bpo-34101: Add doc of PyBuffer_GetPointer (GH-14994)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/29a3a33d99dae0106c6af9d0fd75a11bef26d15c
commit: 29a3a33d99dae0106c6af9d0fd75a11bef26d15c
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-07-31T08:04:31-07:00
summary:

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

(cherry picked from commit 1b29af83bc17e773b0c0d117f5fe1018fde46b0d)

Co-authored-by: Hai Shi <shihai1992 at gmail.com>

files:
M Doc/c-api/buffer.rst

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