diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-09-17 15:55:57 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-18 00:55:57 +0200 |
commit | bba2332303c60d7326f08aa639ff03a6b5d44d04 (patch) | |
tree | 3619cf58e5bf1442acc80e0ec409f82cebc8bc84 | |
parent | c4be7ca087512b69a25624dcf3e7a1384cdc7041 (diff) | |
download | cpython-git-bba2332303c60d7326f08aa639ff03a6b5d44d04.tar.gz |
bpo-42038: fix description of returned list of lines (GH-27529) (GH-28428)
(cherry picked from commit aca0e08c5dcc11a8011697331931cde0b21270f2)
Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
-rw-r--r-- | Doc/library/tracemalloc.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/tracemalloc.rst b/Doc/library/tracemalloc.rst index 20f668c728..68432aeaec 100644 --- a/Doc/library/tracemalloc.rst +++ b/Doc/library/tracemalloc.rst @@ -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. |