]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] gh-141004: Document `PyBUF_WRITEABLE` (GH-141255) (GH-141261)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sat, 8 Nov 2025 17:36:00 +0000 (18:36 +0100)
committerGitHub <noreply@github.com>
Sat, 8 Nov 2025 17:36:00 +0000 (17:36 +0000)
gh-141004: Document `PyBUF_WRITEABLE` (GH-141255)
(cherry picked from commit 5e5fc0404ed983bb37a19793a5c802d0d9852e5d)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Doc/c-api/buffer.rst

index d3081894eadaf5e8742c7ddb16bc8ba7f30bec7e..6bb72a2312be3bbaefc2b56615c3c3e462791a5f 100644 (file)
@@ -261,6 +261,10 @@ readonly, format
       MUST be consistent for all consumers. For example, :c:expr:`PyBUF_SIMPLE | PyBUF_WRITABLE`
       can be used to request a simple writable buffer.
 
+   .. c:macro:: PyBUF_WRITEABLE
+
+      This is a :term:`soft deprecated` alias to :c:macro:`PyBUF_WRITABLE`.
+
    .. c:macro:: PyBUF_FORMAT
 
       Controls the :c:member:`~Py_buffer.format` field. If set, this field MUST