[Python-checkins] bpo-35300: Add usage note to the lru_cache() docs (GH-10707)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/f0e0f2008d160cdd7e5bc02ea61c43f8c7b2b82f
commit: f0e0f2008d160cdd7e5bc02ea61c43f8c7b2b82f
branch: master
author: Raymond Hettinger <rhettinger at users.noreply.github.com>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2018-11-25T16:24:52-08:00
summary:

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



https://bugs.python.org/issue35300

files:
M Doc/library/functools.rst

diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 40abdc24883c..cd59e5bebfd5 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -118,6 +118,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)