Apply documentation suggestions from code review

canova · hugovk · web-flow · commit 2830252b9291 · 2025-07-17T11:37:28.000+02:00
Co-authored-by: Hugo van Kemenade &lt;1324225+hugovk@users.noreply.github.com&gt;
diff --git a/Doc/c-api/perfmaps.rst b/Doc/c-api/perfmaps.rst
@@ -5,7 +5,7 @@
 Support for Perf Maps
 ----------------------
 
-On supported platforms (as of this writing, Linux and macOS), the runtime can take
+On supported platforms (Linux and macOS), the runtime can take
 advantage of *perf map files* to make Python functions visible to an external
 profiling tool (such as `perf <https://perf.wiki.kernel.org/index.php/Main_Page>`_ or
 `samply <https://github.com/mstange/samply/>`_). A running process may create a
diff --git a/Doc/howto/perf_profiling.rst b/Doc/howto/perf_profiling.rst
@@ -28,8 +28,8 @@ relationship between this piece of code and the associated Python function using
 .. note::
 
     Support for profiling is available on Linux and macOS on select architectures.
-    ``perf`` is available on Linux, while ``samply`` can be used on both Linux and macOS.
-    ``samply`` support on macOS is available starting from Python 3.14.
+    Perf is available on Linux, while samply can be used on both Linux and macOS.
+    samply support on macOS is available starting from Python 3.14.
     Check the output of the ``configure`` build step or
     check the output of ``python -m sysconfig | grep HAVE_PERF_TRAMPOLINE``
     to see if your system is supported.
@@ -149,25 +149,25 @@ Instead, if we run the same experiment with ``perf`` support enabled we get:
 
 
 
-Using ``samply`` profiler
+Using the samply profiler
 -------------------------
 
-``samply`` is a modern profiler that can be used as an alternative to ``perf``.
+samply is a modern profiler that can be used as an alternative to perf.
 It uses the same perf map files that Python generates, making it compatible
-with Python's profiling support. ``samply`` is particularly useful on macOS
-where ``perf`` is not available.
+with Python's profiling support. samply is particularly useful on macOS
+where perf is not available.
 
-To use ``samply`` with Python, first install it following the instructions at
+To use samply with Python, first install it following the instructions at
 https://github.com/mstange/samply, then run::
 
     $ samply record PYTHONPERFSUPPORT=1 python my_script.py
 
 This will open a web interface where you can analyze the profiling data
-interactively. The advantage of ``samply`` is that it provides a modern
+interactively. The advantage of samply is that it provides a modern
 web-based interface for analyzing profiling data and works on both Linux
 and macOS.
 
-On macOS, ``samply`` support requires Python 3.14 or later.
+On macOS, samply support requires Python 3.14 or later.
 
 How to enable ``perf`` profiling support
 ----------------------------------------
diff --git a/Misc/NEWS.d/next/Core_and_Builtins/2025-07-09-11-15-42.gh-issue-136459.m4Udh8.rst b/Misc/NEWS.d/next/Core_and_Builtins/2025-07-09-11-15-42.gh-issue-136459.m4Udh8.rst
@@ -1,3 +1,3 @@
 Add support for perf trampoline on macOS, to allow profilers wit JIT map
-support to read python calls. While profiling, ``PYTHONPERFSUPPORT=1`` can
+support to read Python calls. While profiling, ``PYTHONPERFSUPPORT=1`` can
 be appended to enable the trampoline.
