summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Shannon <mark@hotpy.org>2022-04-21 17:14:01 (GMT)
committerGitHub <noreply@github.com>2022-04-21 17:14:01 (GMT)
commit5974827c71d884bb3cc58f07a9eaefafe0cbaa6e (patch)
tree802995c5f890f8ccd3b36375f13ebf5307469bac
parentac4ffd3be2049591701fee9f054191cce5ab9762 (diff)
downloadcpython-5974827c71d884bb3cc58f07a9eaefafe0cbaa6e.zip
cpython-5974827c71d884bb3cc58f07a9eaefafe0cbaa6e.tar.gz
cpython-5974827c71d884bb3cc58f07a9eaefafe0cbaa6e.tar.bz2
GH-88756: Update docs for PEP 523 eval function type. (GH-91788)
-rw-r--r--Doc/c-api/init.rst5
-rw-r--r--Doc/whatsnew/3.11.rst4
2 files changed, 8 insertions, 1 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 3fda9c3..9d38fb4 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -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.
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 6540a25..8d74c9b 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -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
------------