summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorandrei kulakov <andrei.avk@gmail.com>2021-09-17 22:24:55 (GMT)
committerGitHub <noreply@github.com>2021-09-17 22:24:55 (GMT)
commitaca0e08c5dcc11a8011697331931cde0b21270f2 (patch)
treee3668da511c3e9b1de062495ac4f3e24726a1bcf
parentd22a700091af35ce52db0b1fbb02115bb6efbb1f (diff)
downloadcpython-aca0e08c5dcc11a8011697331931cde0b21270f2.zip
cpython-aca0e08c5dcc11a8011697331931cde0b21270f2.tar.gz
cpython-aca0e08c5dcc11a8011697331931cde0b21270f2.tar.bz2
bpo-42038: fix description of returned list of lines (GH-27529)
-rw-r--r--Doc/library/tracemalloc.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/tracemalloc.rst b/Doc/library/tracemalloc.rst
index 20f668c..68432ae 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.