Skip to content

bpo-12217 Added linking of pdb, faulthandler and traceback documentation #14754

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

Closed
wants to merge 2 commits into from
Closed
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
8 changes: 8 additions & 0 deletions Doc/library/faulthandler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ Dumping the traceback
Dump the tracebacks of all threads into *file*. If *all_threads* is
``False``, dump only the current thread.

See also :func:`traceback.print_tb` which can be used to print a traceback
object.

.. versionchanged:: 3.5
Added support for passing file descriptor to this function.

Expand Down Expand Up @@ -170,3 +173,8 @@ handler:
File "<stdin>", line 1 in <module>
Segmentation fault


.. seealso::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to put it at the top, rather than at the end? Same remark for pdb.rst.


Module :mod:`pdb`
Interactive source code debugger for Python programs.
7 changes: 7 additions & 0 deletions Doc/library/pdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -536,3 +536,10 @@ by the local file.

.. [1] Whether a frame is considered to originate in a certain module
is determined by the ``__name__`` in the frame globals.


.. seealso::

Module :mod:`faulthandler`
Used to dump Python tracebacks explicitly, on a fault, after a timeout,
or on a user signal.
3 changes: 3 additions & 0 deletions Doc/library/traceback.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ The module defines the following functions:
``sys.stderr``; otherwise it should be an open file or file-like object to
receive the output.

See also :func:`faulthandler.dump_traceback` which can be used to print the
current traceback of all or the current thread.

.. versionchanged:: 3.5
Added negative *limit* support.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Link traceback, pdb and faulthandler documentation.