From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Date: Tue, 29 Apr 2025 16:11:31 +0000 (+0100)
Subject: [3.13] gh-46236: Document `PyUnicodeIter_Type` (GH-132925) (GH-133149)
X-Git-Tag: v3.13.4~200
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ff4134603a8575de96bc3ec4bdb6c9c162a0fd4f;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-46236: Document `PyUnicodeIter_Type` (GH-132925) (GH-133149)

gh-46236: Document `PyUnicodeIter_Type` (GH-132925)

(cherry picked from commit bba14c3e0129dc6c36c304018ab60a5580043f55)

# Conflicts:
#	Doc/c-api/unicode.rst
---

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index d9b6b1f8b93b..7baf8de10c81 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -68,8 +68,14 @@ Python:
 
 .. c:var:: PyTypeObject PyUnicode_Type
 
-   This instance of :c:type:`PyTypeObject` represents the Python Unicode type.  It
-   is exposed to Python code as ``str``.
+   This instance of :c:type:`PyTypeObject` represents the Python Unicode type.
+   It is exposed to Python code as ``str``.
+
+
+.. c:var:: PyTypeObject PyUnicodeIter_Type
+
+   This instance of :c:type:`PyTypeObject` represents the Python Unicode
+   iterator type. It is used to iterate over Unicode string objects.
 
 
 The following APIs are C macros and static inlined functions for fast checks and