Fix warnings

Author: pablogsal

Doc/library/cmdline.rst

@@ -12,7 +12,7 @@ The following modules have a command-line interface.
 * :ref:`calendar <calendar-cli>`
 * :mod:`code`
 * :ref:`compileall <compileall-cli>`
-* :mod:`cProfile`: see :ref:`profiling.tracing <profiling-tracing-cli>`
+* ``cProfile``: see :ref:`profiling.tracing <profiling-tracing-cli>`
 * :ref:`dis <dis-cli>`
 * :ref:`doctest <doctest-cli>`
 * :mod:`!encodings.rot_13`

Doc/library/profile.rst

@@ -49,7 +49,7 @@ a straightforward migration path.
 
 .. note::
 
-   The :mod:`cProfile` module remains available as a backward-compatible alias
+   The ``cProfile`` module remains available as a backward-compatible alias
    to :mod:`profiling.tracing`. Existing code using ``import cProfile`` will
    continue to work without modification.
 

Doc/library/profiling-tracing.rst

@@ -21,8 +21,8 @@ testing scenarios.
 
 .. note::
 
-   This module is also available as :mod:`cProfile` for backward compatibility.
-   The :mod:`cProfile` name will continue to work in all future Python versions.
+   This module is also available as ``cProfile`` for backward compatibility.
+   The ``cProfile`` name will continue to work in all future Python versions.
    Use whichever import style suits your codebase::
 
       # Preferred (new style)
@@ -101,7 +101,7 @@ results to standard output (or saves them to a file).
    standard import mechanism.
 
    .. versionadded:: 3.7
-      The ``-m`` option for :mod:`cProfile`.
+      The ``-m`` option for ``cProfile``.
 
    .. versionadded:: 3.8
       The ``-m`` option for :mod:`profile`.
@@ -305,7 +305,7 @@ this latency, which can make them appear slower than they actually are. This
 error is typically less than one clock tick per call but can become
 significant for functions called many times.
 
-The :mod:`profiling.tracing` module (and its :mod:`cProfile` alias) is
+The :mod:`profiling.tracing` module (and its ``cProfile`` alias) is
 implemented as a C extension with low overhead, so these timing issues are
 less pronounced than with the deprecated pure Python :mod:`profile` module.
 

Doc/library/profiling.rst

@@ -1,4 +1,4 @@
-.. _profiling:
+.. _profiling-module:
 
 ***************************************
 :mod:`profiling` --- Python Profilers
@@ -80,22 +80,22 @@ function calls.
 
 The following table summarizes the key differences:
 
-+-------------------+--------------------------+----------------------+
-| Feature           | Statistical Sampling     | Deterministic        |
-|                   | (:mod:`profiling.sampling`) | (:mod:`profiling.tracing`) |
-+===================+==========================+======================+
-| **Target**        | Running process          | Code you run         |
-+-------------------+--------------------------+----------------------+
-| **Overhead**      | Virtually none           | Moderate             |
-+-------------------+--------------------------+----------------------+
-| **Accuracy**      | Statistical estimate     | Exact call counts    |
-+-------------------+--------------------------+----------------------+
-| **Setup**         | Attach to any PID        | Instrument code      |
-+-------------------+--------------------------+----------------------+
-| **Use Case**      | Production debugging     | Development/testing  |
-+-------------------+--------------------------+----------------------+
-| **Implementation**| C extension              | C extension          |
-+-------------------+--------------------------+----------------------+
++--------------------+------------------------------+------------------------------+
+| Feature            | Statistical Sampling         | Deterministic                |
+|                    | (:mod:`profiling.sampling`)  | (:mod:`profiling.tracing`)   |
++====================+==============================+==============================+
+| **Target**         | Running process              | Code you run                 |
++--------------------+------------------------------+------------------------------+
+| **Overhead**       | Virtually none               | Moderate                     |
++--------------------+------------------------------+------------------------------+
+| **Accuracy**       | Statistical estimate         | Exact call counts            |
++--------------------+------------------------------+------------------------------+
+| **Setup**          | Attach to any PID            | Instrument code              |
++--------------------+------------------------------+------------------------------+
+| **Use Case**       | Production debugging         | Development/testing          |
++--------------------+------------------------------+------------------------------+
+| **Implementation** | C extension                  | C extension                  |
++--------------------+------------------------------+------------------------------+
 
 
 When to Use Statistical Sampling
@@ -227,14 +227,14 @@ filename:lineno(function)
 Legacy Compatibility
 ====================
 
-For backward compatibility, the :mod:`cProfile` module remains available as an
+For backward compatibility, the ``cProfile`` module remains available as an
 alias to :mod:`profiling.tracing`. Existing code using ``import cProfile`` will
 continue to work without modification in all future Python versions.
 
 .. deprecated:: 3.15
 
    The pure Python :mod:`profile` module is deprecated and will be removed in
-   Python 3.17. Use :mod:`profiling.tracing` (or its alias :mod:`cProfile`)
+   Python 3.17. Use :mod:`profiling.tracing` (or its alias ``cProfile``)
    instead. See :mod:`profile` for migration guidance.
 
 

Doc/library/pstats.rst

@@ -21,8 +21,8 @@ Reading and Displaying Profile Data
 ===================================
 
 The :class:`Stats` class is the primary interface for working with profile
-data. It can read statistics from files or directly from a :class:`Profile`
-object.
+data. It can read statistics from files or directly from a
+:class:`~profiling.tracing.Profile` object.
 
 Load statistics from a file and print a basic report::
 
@@ -269,7 +269,7 @@ The :class:`Stats` Class
       For each function in the filtered results, shows which functions called
       it and how often.
 
-      With :mod:`profiling.tracing` (or :mod:`cProfile`), each caller line
+      With :mod:`profiling.tracing` (or ``cProfile``), each caller line
       shows three numbers: the number of calls from that caller, and the
       total and cumulative times for those specific calls.
 
@@ -286,10 +286,10 @@ The :class:`Stats` Class
 
    .. method:: get_stats_profile()
 
-      Return a :class:`StatsProfile` object containing the statistics.
+      Return a ``StatsProfile`` object containing the statistics.
 
       The returned object provides programmatic access to the profile data,
-      with function names mapped to :class:`FunctionProfile` objects
+      with function names mapped to ``FunctionProfile`` objects
       containing timing and call count information.
 
       .. versionadded:: 3.9

Doc/whatsnew/3.15.rst

@@ -86,10 +86,10 @@ A new :mod:`profiling` module has been added to organize Python's built-in
 profiling tools under a single, coherent namespace. This module contains:
 
 * :mod:`profiling.tracing`: deterministic function-call tracing (relocated from
-  :mod:`cProfile`).
+  ``cProfile``).
 * :mod:`profiling.sampling`: a new statistical sampling profiler (named Tachyon).
 
-The :mod:`cProfile` module remains as an alias for backwards compatibility.
+The ``cProfile`` module remains as an alias for backwards compatibility.
 The :mod:`profile` module is deprecated and will be removed in Python 3.17.
 
 .. seealso:: :pep:`799` for further details.