]> granicus.if.org Git - python/commitdiff
bpo-37698: Update doc of PyBuffer_ToContiguous (GH-14992)
authorHai Shi <shihai1992@gmail.com>
Wed, 11 Sep 2019 17:25:55 +0000 (12:25 -0500)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 11 Sep 2019 17:25:55 +0000 (10:25 -0700)
https://bugs.python.org/issue37698

Doc/c-api/buffer.rst

index fb9d47b16c9fccedce0e318a746de00b3fd3cfa0..e660716856b6df4472446d5773d33c9e2cae0b1b 100644 (file)
@@ -493,8 +493,8 @@ Buffer-related functions
 .. 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.
+   *order* can be ``'C'`` or ``'F'`` or ``'A'`` (for C-style or Fortran-style
+   ordering or either one). ``0`` is returned on success, ``-1`` on error.
 
    This function fails if *len* != *src->len*.