]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
GH-88756: Update docs for PEP 523 eval function type. (GH-91788)
authorMark Shannon <mark@hotpy.org>
Thu, 21 Apr 2022 17:14:01 +0000 (18:14 +0100)
committerGitHub <noreply@github.com>
Thu, 21 Apr 2022 17:14:01 +0000 (18:14 +0100)
Doc/c-api/init.rst
Doc/whatsnew/3.11.rst

index 3fda9c3af4d2a56e37d36482a57a642f0f8a8045..9d38fb47d10d6e87832fd722dfc0e66bc9d136d0 100644 (file)
@@ -1228,7 +1228,7 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
 
    .. versionadded:: 3.8
 
-.. c:type:: PyObject* (*_PyFrameEvalFunction)(PyThreadState *tstate, PyFrameObject *frame, int throwflag)
+.. c:type:: PyObject* (*_PyFrameEvalFunction)(PyThreadState *tstate, _PyInterpreterFrame *frame, int throwflag)
 
    Type of a frame evaluation function.
 
@@ -1238,6 +1238,9 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
    .. versionchanged:: 3.9
       The function now takes a *tstate* parameter.
 
+   .. versionchanged:: 3.11
+      The *frame* parameter changed from ``PyFrameObject*`` to ``_PyInterpreterFrame*``.
+
 .. c:function:: _PyFrameEvalFunction _PyInterpreterState_GetEvalFrameFunc(PyInterpreterState *interp)
 
    Get the frame evaluation function.
index 6540a255a0ed82c52a761e3f10f14ef3f827b7f5..8d74c9bbebad879f74a958fddf3f396e5ad09893 100644 (file)
@@ -1155,6 +1155,10 @@ C API Changes
   be used for ``size``.
   (Contributed by Kumar Aditya in :issue:`46608`.)
 
+* :c:func:`_PyFrameEvalFunction` now takes ``_PyInterpreterFrame*``
+  as its second parameter, instead of ``PyFrameObject*``.
+  See :pep:`523` for more details of how to use this function pointer type.
+
 New Features
 ------------