summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorBrett Cannon <brett@python.org>2016-04-15 19:43:50 (GMT)
committerBrett Cannon <brett@python.org>2016-04-15 19:43:50 (GMT)
commitabf797df66c4c87e508a4a2fd71e3cb19a8624ac (patch)
tree9a378b4eb8fea77ec49ee4cfafdbab8665bd0241 /Doc/c-api
parentf3ad042bfb1ea4de7358d1c7cd8b5a2eb9e21d01 (diff)
downloadcpython-abf797df66c4c87e508a4a2fd71e3cb19a8624ac.zip
cpython-abf797df66c4c87e508a4a2fd71e3cb19a8624ac.tar.gz
cpython-abf797df66c4c87e508a4a2fd71e3cb19a8624ac.tar.bz2
Issue #26760: Minimally document PyFrameObject
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/veryhigh.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst
index f8aaf0f..706efdf 100644
--- a/Doc/c-api/veryhigh.rst
+++ b/Doc/c-api/veryhigh.rst
@@ -307,10 +307,16 @@ the same library that the Python runtime is using.
cells.
+.. c:type:: PyFrameObject
+
+ The C structure of the objects used to describe frame objects. The
+ fields of this type are subject to change at any time.
+
+
.. c:function:: PyObject* PyEval_EvalFrame(PyFrameObject *f)
Evaluate an execution frame. This is a simplified interface to
- PyEval_EvalFrameEx, for backward compatibility.
+ :c:func:`PyEval_EvalFrameEx`, for backward compatibility.
.. c:function:: PyObject* PyEval_EvalFrameEx(PyFrameObject *f, int throwflag)