From: Harjoth Khara <harjoth.khara@gmail.com>
Date: Thu, 18 Jun 2026 16:55:06 +0000 (-0700)
Subject: gh-146353: Document `PyBytesWriter_GetData` pointer validity (GH-151418)
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e99b319682fe984074e32f52354dbec23ded4d0a;p=thirdparty%2FPython%2Fcpython.git

gh-146353: Document `PyBytesWriter_GetData` pointer validity (GH-151418)
---

diff --git a/Doc/c-api/bytes.rst b/Doc/c-api/bytes.rst
index f56bcd6333a3..fa77d3d38ff8 100644
--- a/Doc/c-api/bytes.rst
+++ b/Doc/c-api/bytes.rst
@@ -384,14 +384,18 @@ Getters
 
    Get the writer size.
 
+   The function does not invalidate pointers returned by
+   :c:func:`PyBytesWriter_GetData`.
+
    The function cannot fail.
 
 .. c:function:: void* PyBytesWriter_GetData(PyBytesWriter *writer)
 
    Get the writer data: start of the internal buffer.
 
-   The pointer is valid until :c:func:`PyBytesWriter_Finish` or
-   :c:func:`PyBytesWriter_Discard` is called on *writer*.
+   The pointer remains valid until a :c:type:`PyBytesWriter` function other
+   than :c:func:`PyBytesWriter_GetData` or :c:func:`PyBytesWriter_GetSize` is
+   called on *writer*.
 
    The function cannot fail.