Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-101100: Fix dangling refs in bdb.rst #114983

Merged
merged 4 commits into from
Feb 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions Doc/library/bdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Bdb.set_quit>` attributes with values ready to start debugging.

.. method:: trace_dispatch(frame, event, arg)

Expand Down Expand Up @@ -182,31 +182,31 @@ 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 <Bdb.set_quit>` 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.

.. method:: dispatch_call(frame, arg)

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 <Bdb.set_quit>` 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.

.. method:: dispatch_return(frame, arg)

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 <Bdb.set_quit>` 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.

.. method:: dispatch_exception(frame, arg)

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 <Bdb.set_quit>` 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.

Expand Down Expand Up @@ -293,7 +293,9 @@ The :mod:`bdb` module also defines two classes:

smontanaro marked this conversation as resolved.
Show resolved Hide resolved
.. method:: set_quit()

Set the :attr:`quitting` attribute to ``True``. This raises :exc:`BdbQuit` in
.. 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.


Expand Down Expand Up @@ -383,7 +385,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)

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading