]> granicus.if.org Git - python/commitdiff
Add usage note.
authorRaymond Hettinger <python@rcn.com>
Mon, 4 Jun 2012 07:32:15 +0000 (00:32 -0700)
committerRaymond Hettinger <python@rcn.com>
Mon, 4 Jun 2012 07:32:15 +0000 (00:32 -0700)
Doc/library/functools.rst

index 1b0d82a4bf3593606fbe4c89a5d58b0f44debabf..f5c6608e1d465c6d75b4a0512affada7b364db3d 100644 (file)
@@ -49,8 +49,9 @@ The :mod:`functools` module defines the following functions:
    Since a dictionary is used to cache results, the positional and keyword
    arguments to the function must be hashable.
 
-   If *maxsize* is set to None, the LRU feature is disabled and the cache
-   can grow without bound.
+   If *maxsize* is set to None, the LRU feature is disabled and the cache can
+   grow without bound.  The LRU feature performs best when *maxsize* is a
+   power-of-two.
 
    If *typed* is set to True, function arguments of different types will be
    cached separately.  For example, ``f(3)`` and ``f(3.0)`` will be treated