[Python-checkins] bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988)

Miss Islington (bot) webhook-mailer at python.org
Wed Sep 11 12:38:50 EDT 2019


https://github.com/python/cpython/commit/5a56ce4a0e820fefcd598b94715a7ff7e199858d
commit: 5a56ce4a0e820fefcd598b94715a7ff7e199858d
branch: master
author: Hai Shi <shihai1992 at gmail.com>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2019-09-11T09:38:47-07:00
summary:

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



https://bugs.python.org/issue37750



Automerge-Triggered-By: @matrixise

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

diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 2536c743b247..fb9d47b16c9f 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -483,6 +483,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*.



More information about the Python-checkins mailing list