bpo-33126: Document PyBuffer_ToContiguous() (pythonGH-6292) (pythonGH-6293)

miss-islington · pitrou · pitrou · commit 18fdc87207ea · 2018-03-28T17:47:34.000+02:00
(cherry picked from commit aa50bf0) Co-authored-by: Antoine Pitrou <pitrou@free.fr>
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
@@ -473,6 +473,15 @@ Buffer-related functions
    (*order* is ``'A'``).  Return ``0`` otherwise.
 
 
+.. 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*.
+   *order* can be ``'C'`` or ``'F'`` (for C-style or Fortran-style ordering).
+   ``0`` is returned on success, ``-1`` on error.
+
+   This function fails if *len* != *src->len*.
+
+
 .. c:function:: void PyBuffer_FillContiguousStrides(int ndims, Py_ssize_t *shape, Py_ssize_t *strides, int itemsize, char order)
 
    Fill the *strides* array with byte-strides of a :term:`contiguous` (C-style if
@@ -497,6 +506,3 @@ Buffer-related functions
    If this function is used as part of a :ref:`getbufferproc <buffer-structs>`,
    *exporter* MUST be set to the exporting object and *flags* must be passed
    unmodified. Otherwise, *exporter* MUST be NULL.
-
-
-
diff --git a/Misc/NEWS.d/next/Documentation/2018-03-28-17-03-17.bpo-33126.5UGkNv.rst b/Misc/NEWS.d/next/Documentation/2018-03-28-17-03-17.bpo-33126.5UGkNv.rst
@@ -0,0 +1 @@
+Document PyBuffer_ToContiguous().
