]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add a mention of PYTHONBREAKPOINT to breakpoint() docs (#104430)
authorNed Batchelder <ned@nedbatchelder.com>
Sat, 13 May 2023 07:12:03 +0000 (00:12 -0700)
committerGitHub <noreply@github.com>
Sat, 13 May 2023 07:12:03 +0000 (00:12 -0700)
Doc/library/functions.rst

index 48a832db60e919b63bd605b33a93b5e4fd3f7ad8..3d2bb8efc95d8eb1ee0fb69fd02cb85b7a28e02d 100644 (file)
@@ -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