From: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Date: Tue, 13 Feb 2024 14:23:10 +0000 (+0800)
Subject: gh-113437: Update documentation about PyUnicode_AsWideChar() function (GH-113455)
X-Git-Tag: v3.13.0a4~43
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5719aa23ab7f1c7a5f03309ca4044078a98e7b59;p=thirdparty%2FPython%2Fcpython.git

gh-113437: Update documentation about PyUnicode_AsWideChar() function (GH-113455)
---

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 5541eaa52180..666ffe89605c 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -854,7 +854,12 @@ wchar_t Support
    Copy the Unicode object contents into the :c:type:`wchar_t` buffer *wstr*.  At most
    *size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing
    null termination character).  Return the number of :c:type:`wchar_t` characters
-   copied or ``-1`` in case of an error.  Note that the resulting :c:expr:`wchar_t*`
+   copied or ``-1`` in case of an error.
+
+   When *wstr* is ``NULL``, instead return the *size* that would be required
+   to store all of *unicode* including a terminating null.
+
+   Note that the resulting :c:expr:`wchar_t*`
    string may or may not be null-terminated.  It is the responsibility of the caller
    to make sure that the :c:expr:`wchar_t*` string is null-terminated in case this is
    required by the application. Also, note that the :c:expr:`wchar_t*` string