From: Raymond Hettinger <rhettinger@users.noreply.github.com>
Date: Sun, 18 Sep 2022 21:36:20 +0000 (-0500)
Subject: GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
X-Git-Tag: v3.12.0a1~390
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bbc24b2bd569108b957ed24c5a95ffeaf8cde0db;p=thirdparty%2FPython%2Fcpython.git

GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
---

diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index 6514c00d1114..a3fb2fa5323c 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -1897,6 +1897,8 @@ The classes can be used like this:
     'blog-why-python-rocks'
 
 
+.. _faq-cache-method-calls:
+
 How do I cache method calls?
 ----------------------------
 
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 47cbe59fa492..943a05c39d68 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -197,6 +197,9 @@ The :mod:`functools` module defines the following functions:
    The cache keeps references to the arguments and return values until they age
    out of the cache or until the cache is cleared.
 
+   If a method is cached, the `self` instance argument is included in the
+   cache.  See :ref:`faq-cache-method-calls`
+
    An `LRU (least recently used) cache
    <https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_recently_used_(LRU)>`_
    works best when the most recent calls are the best predictors of upcoming