summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorAlex Waygood <Alex.Waygood@Gmail.com>2023-12-05 19:27:59 (GMT)
committerGitHub <noreply@github.com>2023-12-05 19:27:59 (GMT)
commitd109f637c048c2b5fc95dc7fdfd50f8ac41a7747 (patch)
tree2b8058dcc8b981de885b29f7e537fbd53a3702aa /Doc/library/sys.rst
parentc2e2df83560a3d4cb602f6d57cb70ac8aad7f9e6 (diff)
downloadcpython-d109f637c048c2b5fc95dc7fdfd50f8ac41a7747.zip
cpython-d109f637c048c2b5fc95dc7fdfd50f8ac41a7747.tar.gz
cpython-d109f637c048c2b5fc95dc7fdfd50f8ac41a7747.tar.bz2
gh-101100: Properly document frame object attributes (#112735)
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 7f35981..aaf7920 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -1600,7 +1600,8 @@ always available.
:file:`Objects/lnotab_notes.txt` for a detailed explanation of how this
works.
Per-line events may be disabled for a frame by setting
- :attr:`!f_trace_lines` to :const:`False` on that :ref:`frame <frame-objects>`.
+ :attr:`~frame.f_trace_lines` to :const:`False` on that
+ :ref:`frame <frame-objects>`.
``'return'``
A function (or other code block) is about to return. The local trace
@@ -1618,7 +1619,7 @@ always available.
opcode details). The local trace function is called; *arg* is
``None``; the return value specifies the new local trace function.
Per-opcode events are not emitted by default: they must be explicitly
- requested by setting :attr:`!f_trace_opcodes` to :const:`True` on the
+ requested by setting :attr:`~frame.f_trace_opcodes` to :const:`True` on the
:ref:`frame <frame-objects>`.
Note that as an exception is propagated down the chain of callers, an
@@ -1648,8 +1649,8 @@ always available.
.. versionchanged:: 3.7
- ``'opcode'`` event type added; :attr:`!f_trace_lines` and
- :attr:`!f_trace_opcodes` attributes added to frames
+ ``'opcode'`` event type added; :attr:`~frame.f_trace_lines` and
+ :attr:`~frame.f_trace_opcodes` attributes added to frames
.. function:: set_asyncgen_hooks(firstiter, finalizer)