From 03a22580af9179a4d1e7d496bb915d48e8f94df1 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 13 May 2023 00:12:03 -0700 Subject: [PATCH] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (cherry picked from commit 1be80ed107deb15b926f2794b8e6a7a527b8b84c) Co-authored-by: Ned Batchelder --- Doc/library/functions.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index f3dc02f03db0e9..d1ce1520fdbb5d 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -168,6 +168,13 @@ are always available. They are listed here in alphabetical order. If :func:`sys.breakpointhook` is not accessible, this function will raise :exc:`RuntimeError`. + By default, the behavior of :func:`breakpoint` can be changed with + the :envvar:`PYTHONBREAKPOINT` environment variable. + See :func:`sys.breakpointhook` for usage details. + + Note that this is not guaranteed if :func:`sys.breakpointhook` + has been replaced. + .. audit-event:: builtins.breakpoint breakpointhook breakpoint .. versionadded:: 3.7