]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-46236: Document `PyUnicodeIter_Type` (GH-132925) (GH-133149)
authorStan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Tue, 29 Apr 2025 16:11:31 +0000 (17:11 +0100)
committerGitHub <noreply@github.com>
Tue, 29 Apr 2025 16:11:31 +0000 (18:11 +0200)
gh-46236: Document `PyUnicodeIter_Type` (GH-132925)

(cherry picked from commit bba14c3e0129dc6c36c304018ab60a5580043f55)

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

Doc/c-api/unicode.rst

index d9b6b1f8b93b3197893e78e63f7bc888a12672dc..7baf8de10c8175557adc9986d330e166849e40b8 100644 (file)
@@ -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