From cff570b838f46e84fa31ed763f39f14ebbdacc7a Mon Sep 17 00:00:00 2001 From: Skip Montanaro Date: Sat, 3 Feb 2024 18:47:11 -0600 Subject: [PATCH 1/4] Fix dangling refs in bdb.rst --- Doc/library/bdb.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst index 52f0ca7c013482..afc27cb9f90042 100644 --- a/Doc/library/bdb.rst +++ b/Doc/library/bdb.rst @@ -148,8 +148,8 @@ The :mod:`bdb` module also defines two classes: .. method:: reset() - Set the :attr:`botframe`, :attr:`stopframe`, :attr:`returnframe` and - :attr:`quitting` attributes with values ready to start debugging. + `Set the :attr:`botframe`, :attr:`!stopframe`, :attr:`!returnframe` and + :attr:`quitting ` attributes with values ready to start debugging. .. method:: trace_dispatch(frame, event, arg) @@ -182,7 +182,7 @@ The :mod:`bdb` module also defines two classes: If the debugger should stop on the current line, invoke the :meth:`user_line` method (which should be overridden in subclasses). - Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + Raise a :exc:`BdbQuit` exception if the :attr:`quitting ` flag is set (which can be set from :meth:`user_line`). Return a reference to the :meth:`trace_dispatch` method for further tracing in that scope. @@ -190,7 +190,7 @@ The :mod:`bdb` module also defines two classes: If the debugger should stop on this function call, invoke the :meth:`user_call` method (which should be overridden in subclasses). - Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + Raise a :exc:`BdbQuit` exception if the :attr:`quitting ` flag is set (which can be set from :meth:`user_call`). Return a reference to the :meth:`trace_dispatch` method for further tracing in that scope. @@ -198,7 +198,7 @@ The :mod:`bdb` module also defines two classes: If the debugger should stop on this function return, invoke the :meth:`user_return` method (which should be overridden in subclasses). - Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + Raise a :exc:`BdbQuit` exception if the :attr:`quitting ` flag is set (which can be set from :meth:`user_return`). Return a reference to the :meth:`trace_dispatch` method for further tracing in that scope. @@ -206,7 +206,7 @@ The :mod:`bdb` module also defines two classes: If the debugger should stop at this exception, invokes the :meth:`user_exception` method (which should be overridden in subclasses). - Raise a :exc:`BdbQuit` exception if the :attr:`Bdb.quitting` flag is set + Raise a :exc:`BdbQuit` exception if the :attr:`quitting ` flag is set (which can be set from :meth:`user_exception`). Return a reference to the :meth:`trace_dispatch` method for further tracing in that scope. @@ -293,7 +293,7 @@ The :mod:`bdb` module also defines two classes: .. method:: set_quit() - Set the :attr:`quitting` attribute to ``True``. This raises :exc:`BdbQuit` in + Set the :attr:`!quitting` attribute to ``True``. This raises :exc:`BdbQuit` in the next call to one of the :meth:`!dispatch_\*` methods. @@ -383,7 +383,7 @@ The :mod:`bdb` module also defines two classes: .. method:: run(cmd, globals=None, locals=None) Debug a statement executed via the :func:`exec` function. *globals* - defaults to :attr:`__main__.__dict__`, *locals* defaults to *globals*. + defaults to :attr:`!__main__.__dict__`, *locals* defaults to *globals*. .. method:: runeval(expr, globals=None, locals=None) From ef1ba547d63b307084e14b9c68e3ace7f5cc0e5f Mon Sep 17 00:00:00 2001 From: Skip Montanaro Date: Sun, 4 Feb 2024 07:28:40 -0600 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: AN Long --- Doc/library/bdb.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst index afc27cb9f90042..d7d988280b7082 100644 --- a/Doc/library/bdb.rst +++ b/Doc/library/bdb.rst @@ -148,7 +148,7 @@ The :mod:`bdb` module also defines two classes: .. method:: reset() - `Set the :attr:`botframe`, :attr:`!stopframe`, :attr:`!returnframe` and + Set the :attr:`botframe`, :attr:`!stopframe`, :attr:`!returnframe` and :attr:`quitting ` attributes with values ready to start debugging. .. method:: trace_dispatch(frame, event, arg) From a453cb2d8a8640e392bb5830db84cd3bf4ea0944 Mon Sep 17 00:00:00 2001 From: Skip Montanaro Date: Thu, 8 Feb 2024 09:30:09 -0600 Subject: [PATCH 3/4] suppress `stopframe` message, add `quitting` index entry --- Doc/library/bdb.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst index d7d988280b7082..7bf4308a96d0f5 100644 --- a/Doc/library/bdb.rst +++ b/Doc/library/bdb.rst @@ -148,7 +148,7 @@ The :mod:`bdb` module also defines two classes: .. method:: reset() - Set the :attr:`botframe`, :attr:`!stopframe`, :attr:`!returnframe` and + Set the :attr:`!botframe`, :attr:`!stopframe`, :attr:`!returnframe` and :attr:`quitting ` attributes with values ready to start debugging. .. method:: trace_dispatch(frame, event, arg) @@ -293,6 +293,8 @@ The :mod:`bdb` module also defines two classes: .. method:: set_quit() + .. index:: single: quitting (bdb.Bdb attribute) + Set the :attr:`!quitting` attribute to ``True``. This raises :exc:`BdbQuit` in the next call to one of the :meth:`!dispatch_\*` methods. From 1728e2c17d5019596e9eb2f664c654898d65a802 Mon Sep 17 00:00:00 2001 From: Skip Montanaro Date: Sat, 10 Feb 2024 17:42:42 -0600 Subject: [PATCH 4/4] complete --- Doc/tools/.nitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 7127f30f240ce7..65392f1d12eb9a 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -22,7 +22,6 @@ Doc/library/ast.rst Doc/library/asyncio-extending.rst Doc/library/asyncio-policy.rst Doc/library/asyncio-subprocess.rst -Doc/library/bdb.rst Doc/library/collections.rst Doc/library/dbm.rst Doc/library/decimal.rst