summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2023-05-13 00:12:03 -0700
committerGitHub <noreply@github.com>2023-05-13 00:12:03 -0700
commit1be80ed107deb15b926f2794b8e6a7a527b8b84c (patch)
tree2a17c735762cca0bc02f1ea4a82b15aafaba57a0
parent57139a6b5f0cfa04156d5c650026012a7c5a7aad (diff)
downloadcpython-git-1be80ed107deb15b926f2794b8e6a7a527b8b84c.tar.gz
Add a mention of PYTHONBREAKPOINT to breakpoint() docs (#104430)
-rw-r--r--Doc/library/functions.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 48a832db60..3d2bb8efc9 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