Skip to content

Commit

Permalink
bpo-33126: Document PyBuffer_ToContiguous() (python#6292)
Browse files Browse the repository at this point in the history
  • Loading branch information
pitrou authored Mar 28, 2018
1 parent 40a536b commit aa50bf0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
12 changes: 9 additions & 3 deletions Doc/c-api/buffer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document PyBuffer_ToContiguous().

0 comments on commit aa50bf0

Please sign in to comment.