Skip to content

Commit

Permalink
bpo-42038: fix description of returned list of lines (GH-27529)
Browse files Browse the repository at this point in the history
  • Loading branch information
akulakov authored Sep 17, 2021
1 parent d22a700 commit aca0e08
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Doc/library/tracemalloc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -740,12 +740,12 @@ Traceback

.. method:: format(limit=None, most_recent_first=False)

Format the traceback as a list of lines with newlines. Use the
:mod:`linecache` module to retrieve lines from the source code.
If *limit* is set, format the *limit* most recent frames if *limit*
is positive. Otherwise, format the ``abs(limit)`` oldest frames.
If *most_recent_first* is ``True``, the order of the formatted frames
is reversed, returning the most recent frame first instead of last.
Format the traceback as a list of lines. Use the :mod:`linecache` module to
retrieve lines from the source code. If *limit* is set, format the *limit*
most recent frames if *limit* is positive. Otherwise, format the
``abs(limit)`` oldest frames. If *most_recent_first* is ``True``, the order
of the formatted frames is reversed, returning the most recent frame first
instead of last.

Similar to the :func:`traceback.format_tb` function, except that
:meth:`.format` does not include newlines.
Expand Down

0 comments on commit aca0e08

Please sign in to comment.