diff options
| author | Irit Katriel <1055913+iritkatriel@users.noreply.github.com> | 2021-09-03 21:39:23 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-03 21:39:23 (GMT) |
| commit | 0b58e863df9970b290a4de90c67f9ac30c443817 (patch) | |
| tree | 610e3f661be0280739656ff3072eab3f5307b545 /Doc/library/traceback.rst | |
| parent | 6f8bc464e006f672d1aeafbfd7c774a40215dab2 (diff) | |
| download | cpython-0b58e863df9970b290a4de90c67f9ac30c443817.zip cpython-0b58e863df9970b290a4de90c67f9ac30c443817.tar.gz cpython-0b58e863df9970b290a4de90c67f9ac30c443817.tar.bz2 | |
bpo-45075: distinguish between frame and FrameSummary in traceback mo… (GH-28112)
Diffstat (limited to 'Doc/library/traceback.rst')
| -rw-r--r-- | Doc/library/traceback.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 7b23049..df4a38c 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -353,12 +353,12 @@ capture data for later printing in a lightweight fashion. .. versionchanged:: 3.6 Long sequences of repeated frames are now abbreviated. - .. method:: format_frame(frame) + .. method:: format_frame_summary(frame_summary) Returns a string for printing one of the frames involved in the stack. - This method gets called for each frame object to be printed in the - :class:`StackSummary`. If it returns ``None``, the frame is omitted - from the output. + This method is called for each :class:`FrameSummary` object to be + printed by :meth:`StackSummary.format`. If it returns ``None``, the + frame is omitted from the output. .. versionadded:: 3.11 @@ -368,7 +368,7 @@ capture data for later printing in a lightweight fashion. .. versionadded:: 3.5 -:class:`FrameSummary` objects represent a single frame in a traceback. +A :class:`FrameSummary` object represents a single frame in a traceback. .. class:: FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None) |