From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 22 Nov 2022 15:50:39 +0000 (-0800)
Subject: gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)
X-Git-Tag: v3.11.1~62
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9a4b2f4f7f81d00ee562c344883828e5db96c973;p=thirdparty%2FPython%2Fcpython.git

gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)

(cherry picked from commit d15b9f19ac0ffb29b646735d69b29f48a71c247f)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
---

diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst
index 46ce700abf14..b52f3477ee23 100644
--- a/Doc/c-api/frame.rst
+++ b/Doc/c-api/frame.rst
@@ -19,6 +19,24 @@ can be used to get a frame object.
 
 See also :ref:`Reflection <reflection>`.
 
+.. c:var:: PyTypeObject PyFrame_Type
+
+   The type of frame objects.
+   It is the same object as :py:class:`types.FrameType` in the Python layer.
+
+   .. versionchanged:: 3.11
+
+      Previously, this type was only available after including
+      ``<frameobject.h>``.
+
+.. c:function:: int PyFrame_Check(PyObject *obj)
+
+   Return non-zero if *obj* is a frame object.
+
+   .. versionchanged:: 3.11
+
+      Previously, this function was only available after including
+      ``<frameobject.h>``.
 
 .. c:function:: PyFrameObject* PyFrame_GetBack(PyFrameObject *frame)