summaryrefslogtreecommitdiffstats
path: root/Doc/library/pdb.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/pdb.rst')
-rw-r--r--Doc/library/pdb.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index 6225a3a..c5d4181 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -118,11 +118,15 @@ slightly different way:
is entered.
-.. function:: set_trace()
+.. function:: set_trace(*, header=None)
- Enter the debugger at the calling stack frame. This is useful to hard-code a
- breakpoint at a given point in a program, even if the code is not otherwise
- being debugged (e.g. when an assertion fails).
+ Enter the debugger at the calling stack frame. This is useful to hard-code
+ a breakpoint at a given point in a program, even if the code is not
+ otherwise being debugged (e.g. when an assertion fails). If given,
+ ``header`` is printed to the console just before debugging begins.
+
+ .. versionadded:: 3.7
+ The keyword-only argument ``header``.
.. function:: post_mortem(traceback=None)