]> granicus.if.org Git - python/commitdiff
[3.8] bpo-37698: Update doc of PyBuffer_ToContiguous (GH-14992) (GH-15999)
authorStéphane Wirtel <stephane@wirtel.be>
Wed, 11 Sep 2019 17:36:00 +0000 (19:36 +0200)
committerGitHub <noreply@github.com>
Wed, 11 Sep 2019 17:36:00 +0000 (19:36 +0200)
https://bugs.python.org/issue37698
(cherry picked from commit 15f5a7527b87e11fcf23069c147fd4cb7d42cfb0)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
Doc/c-api/buffer.rst

index 06941e1004097f7f03506497905977218abe7ee3..67140511ef74f44f41c2a9c8dbf3a53a88eb9917 100644 (file)
@@ -491,8 +491,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*.