]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 22 Nov 2022 15:50:39 +0000 (07:50 -0800)
committerGitHub <noreply@github.com>
Tue, 22 Nov 2022 15:50:39 +0000 (07:50 -0800)
(cherry picked from commit d15b9f19ac0ffb29b646735d69b29f48a71c247f)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Doc/c-api/frame.rst

index 46ce700abf14748533bbb7b2ac6764f2f9cba4e8..b52f3477ee23165c37dca1dfb39630ce1268764f 100644 (file)
@@ -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)