Skip to content

Commit 1bcb081

Browse files
committed
Update whatsnew to link to profiling module docs
Enable cross-references to the new profiling module documentation and update the CLI examples to use the current syntax with the attach subcommand. Also reference profiling.tracing instead of cProfile since that's the new canonical name.
1 parent 75413e4 commit 1bcb081

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

Doc/whatsnew/3.15.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,12 @@ New features
8282
:pep:`799`: A dedicated profiling package
8383
-----------------------------------------
8484

85-
A new :mod:`!profiling` module has been added to organize Python's built-in
85+
A new :mod:`profiling` module has been added to organize Python's built-in
8686
profiling tools under a single, coherent namespace. This module contains:
8787

88-
* :mod:`!profiling.tracing`: deterministic function-call tracing (relocated from
88+
* :mod:`profiling.tracing`: deterministic function-call tracing (relocated from
8989
:mod:`cProfile`).
90-
* :mod:`!profiling.sampling`: a new statistical sampling profiler (named Tachyon).
90+
* :mod:`profiling.sampling`: a new statistical sampling profiler (named Tachyon).
9191

9292
The :mod:`cProfile` module remains as an alias for backwards compatibility.
9393
The :mod:`profile` module is deprecated and will be removed in Python 3.17.
@@ -103,10 +103,10 @@ Tachyon: High frequency statistical sampling profiler
103103
-----------------------------------------------------
104104

105105
A new statistical sampling profiler (Tachyon) has been added as
106-
:mod:`!profiling.sampling`. This profiler enables low-overhead performance analysis of
106+
:mod:`profiling.sampling`. This profiler enables low-overhead performance analysis of
107107
running Python processes without requiring code modification or process restart.
108108

109-
Unlike deterministic profilers (:mod:`cProfile` and :mod:`profile`) that instrument
109+
Unlike deterministic profilers (such as :mod:`profiling.tracing`) that instrument
110110
every function call, the sampling profiler periodically captures stack traces from
111111
running processes. This approach provides virtually zero overhead while achieving
112112
sampling rates of **up to 1,000,000 Hz**, making it the fastest sampling profiler
@@ -168,6 +168,9 @@ Key features include:
168168
(``--async-aware``). See which coroutines are consuming time, with options to show only
169169
running tasks or all tasks including those waiting.
170170

171+
See :mod:`profiling.sampling` for full documentation, including all available
172+
output formats, profiling modes, and configuration options.
173+
171174
(Contributed by Pablo Galindo and László Kiss Kollár in :gh:`135953` and :gh:`138122`.)
172175

173176

0 commit comments

Comments
 (0)