diff options
| author | Alex Waygood <Alex.Waygood@Gmail.com> | 2023-12-05 19:27:59 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-05 19:27:59 (GMT) |
| commit | d109f637c048c2b5fc95dc7fdfd50f8ac41a7747 (patch) | |
| tree | 2b8058dcc8b981de885b29f7e537fbd53a3702aa /Doc/c-api/frame.rst | |
| parent | c2e2df83560a3d4cb602f6d57cb70ac8aad7f9e6 (diff) | |
| download | cpython-d109f637c048c2b5fc95dc7fdfd50f8ac41a7747.zip cpython-d109f637c048c2b5fc95dc7fdfd50f8ac41a7747.tar.gz cpython-d109f637c048c2b5fc95dc7fdfd50f8ac41a7747.tar.bz2 | |
gh-101100: Properly document frame object attributes (#112735)
Diffstat (limited to 'Doc/c-api/frame.rst')
| -rw-r--r-- | Doc/c-api/frame.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst index 1accee2..6bb1e9b 100644 --- a/Doc/c-api/frame.rst +++ b/Doc/c-api/frame.rst @@ -50,7 +50,7 @@ See also :ref:`Reflection <reflection>`. .. c:function:: PyObject* PyFrame_GetBuiltins(PyFrameObject *frame) - Get the *frame*'s ``f_builtins`` attribute. + Get the *frame*'s :attr:`~frame.f_builtins` attribute. Return a :term:`strong reference`. The result cannot be ``NULL``. @@ -81,7 +81,7 @@ See also :ref:`Reflection <reflection>`. .. c:function:: PyObject* PyFrame_GetGlobals(PyFrameObject *frame) - Get the *frame*'s ``f_globals`` attribute. + Get the *frame*'s :attr:`~frame.f_globals` attribute. Return a :term:`strong reference`. The result cannot be ``NULL``. @@ -90,7 +90,7 @@ See also :ref:`Reflection <reflection>`. .. c:function:: int PyFrame_GetLasti(PyFrameObject *frame) - Get the *frame*'s ``f_lasti`` attribute. + Get the *frame*'s :attr:`~frame.f_lasti` attribute. Returns -1 if ``frame.f_lasti`` is ``None``. @@ -120,7 +120,7 @@ See also :ref:`Reflection <reflection>`. .. c:function:: PyObject* PyFrame_GetLocals(PyFrameObject *frame) - Get the *frame*'s ``f_locals`` attribute (:class:`dict`). + Get the *frame*'s :attr:`~frame.f_locals` attribute (:class:`dict`). Return a :term:`strong reference`. |