From: Ned Batchelder <ned@nedbatchelder.com>
Date: Sat, 13 May 2023 07:12:03 +0000 (-0700)
Subject: Add a mention of PYTHONBREAKPOINT to breakpoint() docs (#104430)
X-Git-Tag: v3.12.0b1~134
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1be80ed107deb15b926f2794b8e6a7a527b8b84c;p=thirdparty%2FPython%2Fcpython.git

Add a mention of PYTHONBREAKPOINT to breakpoint() docs (#104430)
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 48a832db60e9..3d2bb8efc95d 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