diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-09-17 15:56:26 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-18 00:56:26 +0200 |
| commit | 6302701179c458da637d669d7e88734fabb79cf6 (patch) | |
| tree | 3c7728ae8dea89756f93df9163b3c1aeb8246827 | |
| parent | 791cfd19034c5aa14f9db69e64baa172b457a789 (diff) | |
| download | cpython-git-6302701179c458da637d669d7e88734fabb79cf6.tar.gz | |
bpo-42038: fix description of returned list of lines (GH-27529) (GH-28429)
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. |