From: Matt Wozniski <godlygeek@gmail.com>
Date: Fri, 6 May 2022 09:37:08 +0000 (-0400)
Subject: Document the lifetime of `PyUnicode_AsUTF8String` (#92325)
X-Git-Tag: v3.11.0b1~14
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=740da8d37a84638f4a8893bee3648f36fc6beb0f;p=thirdparty%2FPython%2Fcpython.git

Document the lifetime of `PyUnicode_AsUTF8String` (#92325)

The current wording implied this, but didn't state it explicitly.
---

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 00faac5b69ab..d139112578ca 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -1075,7 +1075,8 @@ These are the UTF-8 codec APIs:
 
    This caches the UTF-8 representation of the string in the Unicode object, and
    subsequent calls will return a pointer to the same buffer.  The caller is not
-   responsible for deallocating the buffer.
+   responsible for deallocating the buffer. The buffer is deallocated and
+   pointers to it become invalid when the Unicode object is garbage collected.
 
    .. versionadded:: 3.3