summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorTomas R. <tomas.roun8@gmail.com>2024-12-03 16:08:39 (GMT)
committerGitHub <noreply@github.com>2024-12-03 16:08:39 (GMT)
commit8ba9f5bca9c0ce6130e1f4ba761a68f74f8457d0 (patch)
tree16e7ab36bd779602983dc8564ee490182988acb4 /Doc
parent412e11fe6e37f15971ef855f88b8b01bb3297679 (diff)
downloadcpython-8ba9f5bca9c0ce6130e1f4ba761a68f74f8457d0.zip
cpython-8ba9f5bca9c0ce6130e1f4ba761a68f74f8457d0.tar.gz
cpython-8ba9f5bca9c0ce6130e1f4ba761a68f74f8457d0.tar.bz2
gh-127347: Document `traceback.print_list` (#127348)
Previously, `traceback.print_list` didn't have a documentation entry and was not exposed in `traceback.__all__`. Now it has a documentation entry and is exposed in `__all__`.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/traceback.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst
index 100a92b..8f94fc4 100644
--- a/Doc/library/traceback.rst
+++ b/Doc/library/traceback.rst
@@ -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