From: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Date: Tue, 4 Jun 2024 23:00:02 +0000 (+0100)
Subject: gh-114616: Improve docs regarding changes to caches representation in dis (#120033)
X-Git-Tag: v3.14.0a1~1595
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=770f3c1eadd3392c72fd55be47770234dd143a14;p=thirdparty%2FPython%2Fcpython.git

gh-114616: Improve docs regarding changes to caches representation in dis (#120033)
---

diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index fda46d260bcb..87d1bcdfaf3f 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -336,9 +336,10 @@ operation is being performed, so the intermediate analysis object isn't useful:
       Added the *show_caches* and *adaptive* parameters.
 
    .. versionchanged:: 3.13
-      The *show_caches* parameter is deprecated and has no effect. The *cache_info*
-      field of each instruction is populated regardless of its value.
-
+      The *show_caches* parameter is deprecated and has no effect. The iterator
+      generates the :class:`Instruction` instances with the *cache_info*
+      field populated (regardless of the value of *show_caches*) and it no longer
+      generates separate items for the cache entries.
 
 .. function:: findlinestarts(code)
 
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index dfbeadce0eea..a1d2a0d84e75 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -706,6 +706,13 @@ dis
   the ``show_offsets`` parameter.
   (Contributed by Irit Katriel in :gh:`112137`.)
 
+* :meth:`~dis.get_instructions` no longer represents cache entries as
+  separate instructions. Instead, it returns them as part of the
+  :class:`~dis.Instruction`, in the new *cache_info* field. The
+  *show_caches* argument to :meth:`~dis.get_instructions` is
+  deprecated and no longer has any effect.
+  (Contributed by Irit Katriel in :gh:`112962`.)
+
 .. _whatsnew313-doctest:
 
 doctest