From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 26 Nov 2018 01:00:37 +0000 (-0800)
Subject: bpo-35300: Add usage note to the lru_cache() docs (GH-10707) (GH-10708)
X-Git-Tag: v3.7.2rc1~102
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c7074007272f257a0efab76f03e6b400c30a51b4;p=thirdparty%2FPython%2Fcpython.git

bpo-35300: Add usage note to the lru_cache() docs (GH-10707) (GH-10708)
---

diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 8924593464f9..d19373bb493d 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -85,6 +85,11 @@ The :mod:`functools` module defines the following functions:
    The cache's size limit assures that the cache does not grow without bound on
    long-running processes such as web servers.
 
+   In general, the LRU cache should only be used when you want to reuse
+   previously computed values.  Accordingly, it doesn't make sense to cache
+   functions with side-effects, functions that need to create distinct mutable
+   objects on each call, or impure functions such as time() or random().
+
    Example of an LRU cache for static web content::
 
         @lru_cache(maxsize=32)