[Python-checkins] GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)

[miss-islington]

https://github.com/python/cpython/commit/dbdbc796d264b8d63c89c2ca3ea9634bbaee2d2d
commit: dbdbc796d264b8d63c89c2ca3ea9634bbaee2d2d
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2023-02-03T19:57:34-08:00
summary:

GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)

(cherry picked from commit cef9de62b8bf5e2d11d5a074012dfa81dc4ea935)

Co-authored-by: Furkan Onder <furkanonder at protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach at Gerlach.CAM>

files:
M Doc/library/faulthandler.rst
M Doc/library/pdb.rst
M Doc/library/traceback.rst

diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst
index be0912376bd8..b80de69a79a8 100644
--- a/Doc/library/faulthandler.rst
+++ b/Doc/library/faulthandler.rst
@@ -43,6 +43,13 @@ Python is deadlocked.
 The :ref:`Python Development Mode <devmode>` calls :func:`faulthandler.enable`
 at Python startup.
 
+.. seealso::
+
+   Module :mod:`pdb`
+      Interactive source code debugger for Python programs.
+
+   Module :mod:`traceback`
+      Standard interface to extract, format and print stack traces of Python programs.
 
 Dumping the traceback
 ---------------------
@@ -52,6 +59,8 @@ Dumping the traceback
    Dump the tracebacks of all threads into *file*. If *all_threads* is
    ``False``, dump only the current thread.
 
+   .. seealso:: :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.
 
@@ -178,4 +187,3 @@ handler:
       File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
       File "<stdin>", line 1 in <module>
     Segmentation fault
-
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index dcd509de56ad..c87e32779609 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -27,6 +27,15 @@ The debugger is extensible -- it is actually defined as the class :class:`Pdb`.
 This is currently undocumented but easily understood by reading the source.  The
 extension interface uses the modules :mod:`bdb` and :mod:`cmd`.
 
+.. seealso::
+
+   Module :mod:`faulthandler`
+      Used to dump Python tracebacks explicitly, on a fault, after a timeout,
+      or on a user signal.
+
+   Module :mod:`traceback`
+      Standard interface to extract, format and print stack traces of Python programs.
+
 The debugger's prompt is ``(Pdb)``. Typical usage to run a program under control
 of the debugger is::
 
diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst
index c93e7f49c110..ab51cb9bb2d5 100644
--- a/Doc/library/traceback.rst
+++ b/Doc/library/traceback.rst
@@ -20,8 +20,15 @@ The module uses traceback objects --- this is the object type that is stored in
 the :data:`sys.last_traceback` variable and returned as the third item from
 :func:`sys.exc_info`.
 
-The module defines the following functions:
+.. seealso::
+
+   Module :mod:`faulthandler`
+      Used to dump Python tracebacks explicitly, on a fault, after a timeout, or on a user signal.
 
+   Module :mod:`pdb`
+      Interactive source code debugger for Python programs.
+
+The module defines the following functions:
 
 .. function:: print_tb(tb, limit=None, file=None)