Skip to content

Commit 8602f8a

Browse files
committed
add a mention of PYTHONBREAKPOINT to breakpoint() docs
1 parent b7597da commit 8602f8a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Doc/library/functions.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ are always available. They are listed here in alphabetical order.
154154
.. versionchanged:: 3.7
155155
*x* is now a positional-only parameter.
156156

157-
.. function:: breakpoint(*args, **kws)
157+
.. function:: breakpoint(\*args, \**kws)
158158

159159
This function drops you into the debugger at the call site. Specifically,
160160
it calls :func:`sys.breakpointhook`, passing ``args`` and ``kws`` straight
@@ -168,6 +168,11 @@ are always available. They are listed here in alphabetical order.
168168
If :func:`sys.breakpointhook` is not accessible, this function will
169169
raise :exc:`RuntimeError`.
170170

171+
By default (if :func:`sys.breakpointhook` has not been replaced), the
172+
behavior of :func:`breakpoint` can be changed with the
173+
:envvar:`PYTHONBREAKPOINT`. See the docs for :func:`sys.breakpointhook` for
174+
details.
175+
171176
.. audit-event:: builtins.breakpoint breakpointhook breakpoint
172177

173178
.. versionadded:: 3.7

0 commit comments

Comments
 (0)