]> granicus.if.org Git - python/commitdiff
bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988)
authorHai Shi <shihai1992@gmail.com>
Wed, 11 Sep 2019 16:38:47 +0000 (11:38 -0500)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 11 Sep 2019 16:38:47 +0000 (09:38 -0700)
https://bugs.python.org/issue37750

Automerge-Triggered-By: @matrixise
Doc/c-api/buffer.rst

index 2536c743b2471945afd35c72499ec03605966d2c..fb9d47b16c9fccedce0e318a746de00b3fd3cfa0 100644 (file)
@@ -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*.