From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 11 Sep 2019 17:09:57 +0000 (-0700)
Subject: bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988) (GH-15990)
X-Git-Tag: v3.8.0rc1~163
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4cab7eb9e1f4afc44bac4889de034e031d462e7a;p=python

bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988) (GH-15990)

https://bugs.python.org/issue37750

Automerge-Triggered-By: @matrixise
(cherry picked from commit 5a56ce4a0e820fefcd598b94715a7ff7e199858d)

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

diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index fdb8bd19d2..06941e1004 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -481,6 +481,13 @@ Buffer-related functions
    *indices* must point to an array of ``view->ndim`` indices.
 
 
+.. c:function:: int PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
+
+   Copy contiguous *len* bytes from *buf* to *view*.
+   *fort* can be ``'C'`` or ``'F'`` (for C-style or Fortran-style ordering).
+   ``0`` is returned on success, ``-1`` on error.
+
+
 .. 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*.