summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHai Shi <shihai1992@gmail.com>2019-09-11 11:38:47 -0500
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-09-11 09:38:47 -0700
commit5a56ce4a0e820fefcd598b94715a7ff7e199858d (patch)
tree263be2f187574e1c09af308007394a135f8f855e
parent0b72ccff56fb47e14f7b1f6590eafff8d104c229 (diff)
downloadcpython-git-5a56ce4a0e820fefcd598b94715a7ff7e199858d.tar.gz
bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988)
https://bugs.python.org/issue37750 Automerge-Triggered-By: @matrixise
-rw-r--r--Doc/c-api/buffer.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 2536c743b2..fb9d47b16c 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*.