[Python-checkins] bpo-42038: fix description of returned list of lines (GH-27529) (GH-28428)
ambv
webhook-mailer at python.org
Fri Sep 17 18:56:01 EDT 2021
https://github.com/python/cpython/commit/bba2332303c60d7326f08aa639ff03a6b5d44d04
commit: bba2332303c60d7326f08aa639ff03a6b5d44d04
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2021-09-18T00:55:57+02:00
summary:
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 at gmail.com>
files:
M Doc/library/tracemalloc.rst
diff --git a/Doc/library/tracemalloc.rst b/Doc/library/tracemalloc.rst
index 20f668c728202..68432aeaecbcc 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.
More information about the Python-checkins
mailing list