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

python · Sep 18, 2022 · bbc24b2 · bbc24b2
1 parent 2d1a2d9
commit bbc24b2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git 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
@@ -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
-Original file line number
+Diff line change
@@ Expand Up / @@ -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?
     ----------------------------
@@ Expand Down @@