[Python-checkins] [3.11] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (#104447)

hauntsaninja webhook-mailer at python.org
Sat May 13 03:16:35 EDT 2023


https://github.com/python/cpython/commit/e794d469e3358c10340ff9805f93e9d6c76dc5c1
commit: e794d469e3358c10340ff9805f93e9d6c76dc5c1
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: hauntsaninja <12621235+hauntsaninja at users.noreply.github.com>
date: 2023-05-13T07:16:28Z
summary:

[3.11] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (#104447)

Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430)
(cherry picked from commit 1be80ed107deb15b926f2794b8e6a7a527b8b84c)

Co-authored-by: Ned Batchelder <ned at nedbatchelder.com>

files:
M Doc/library/functions.rst

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index f3dc02f03db0..d1ce1520fdbb 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



More information about the Python-checkins mailing list