From 6023b3b01e286d5b4273af7ef003dd1fa2c5fb0a Mon Sep 17 00:00:00 2001
From: "Miss Islington (bot)"
 <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 13 Dec 2024 10:37:28 +0100
Subject: [PATCH] [3.13] Document PyObject_SelfIter (GH-127861) (#127898)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Document PyObject_SelfIter (GH-127861)
(cherry picked from commit 58942a07df8811afba9c58dc16c1aab244ccf27a)

Co-authored-by: Miro Hrončok <miro@hroncok.cz>
---
 Doc/c-api/object.rst   | 6 ++++++
 Doc/data/refcounts.dat | 3 +++
 2 files changed, 9 insertions(+)

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 1e822fad13aa5d..3f0fd905da5097 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -509,6 +509,12 @@ Object Protocol
    iterated.
 
 
+.. c:function:: PyObject* PyObject_SelfIter(PyObject *obj)
+
+   This is equivalent to the Python ``__iter__(self): return self`` method.
+   It is intended for :term:`iterator` types, to be used in the :c:member:`PyTypeObject.tp_iter` slot.
+
+
 .. c:function:: PyObject* PyObject_GetAIter(PyObject *o)
 
    This is the equivalent to the Python expression ``aiter(o)``. Takes an
diff --git a/Doc/data/refcounts.dat b/Doc/data/refcounts.dat
index e5bb0bf78f7a69..99f4d59b558eae 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -1836,6 +1836,9 @@ PyObject_RichCompareBool:PyObject*:o1:0:
 PyObject_RichCompareBool:PyObject*:o2:0:
 PyObject_RichCompareBool:int:opid::
 
+PyObject_SelfIter:PyObject*::+1:
+PyObject_SelfIter:PyObject*:obj:0:
+
 PyObject_SetAttr:int:::
 PyObject_SetAttr:PyObject*:o:0:
 PyObject_SetAttr:PyObject*:attr_name:0: