[Python-checkins] cpython (3.5): Issue #26760: Minimally document PyFrameObject

[brett.cannon]

https://hg.python.org/cpython/rev/ba6f4f0fe9ea
changeset:   100989:ba6f4f0fe9ea
branch:      3.5
parent:      100986:257dd57dd732
user:        Brett Cannon <brett at python.org>
date:        Fri Apr 15 12:43:50 2016 -0700
summary:
  Issue #26760: Minimally document PyFrameObject

files:
  Doc/c-api/veryhigh.rst |  8 +++++++-
  1 files changed, 7 insertions(+), 1 deletions(-)


diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst
--- a/Doc/c-api/veryhigh.rst
+++ b/Doc/c-api/veryhigh.rst
@@ -307,10 +307,16 @@
    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)

-- 
Repository URL: https://hg.python.org/cpython