From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Date: Tue, 29 Apr 2025 12:23:06 +0000 (+0100)
Subject: gh-46236: Document `PyUnicodeIter_Type` (GH-132925)
X-Git-Tag: v3.14.0b1~199
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bba14c3e0129dc6c36c304018ab60a5580043f55;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 1b426ff3841c..95987e872ce6 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -33,8 +33,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 :py:class:`str`.
+   This instance of :c:type:`PyTypeObject` represents the Python Unicode type.
+   It is exposed to Python code as :py:class:`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.
 
 
 .. c:type:: Py_UCS4