]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-127347: Document `traceback.print_list` (GH-127348) (#127570)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 4 Dec 2024 08:29:10 +0000 (09:29 +0100)
committerGitHub <noreply@github.com>
Wed, 4 Dec 2024 08:29:10 +0000 (10:29 +0200)
Add an documentation entry about `traceback.print_list`

Co-authored-by: Tomas R. <tomas.roun8@gmail.com>
Doc/library/traceback.rst

index 9d57c354523370e278fc7c5a3468178fac0a3c8b..07960e4b1042d4fdf97a52bae1daf25be4ec36a7 100644 (file)
@@ -157,6 +157,13 @@ Module-Level Functions
    arguments have the same meaning as for :func:`print_stack`.
 
 
+.. function:: print_list(extracted_list, file=None)
+
+   Print the list of tuples as returned by :func:`extract_tb` or
+   :func:`extract_stack` as a formatted stack trace to the given file.
+   If *file* is ``None``, the output is written to :data:`sys.stderr`.
+
+
 .. function:: format_list(extracted_list)
 
    Given a list of tuples or :class:`FrameSummary` objects as returned by