Documentation nits.
authorRaymond Hettinger <python@rcn.com>
Tue, 30 Nov 2010 20:02:57 +0000 (20:02 +0000)
committerRaymond Hettinger <python@rcn.com>
Tue, 30 Nov 2010 20:02:57 +0000 (20:02 +0000)
Doc/library/functools.rst

index 7c9b9cabfde19e6cadfa5ce9d39f91223a9efcc9..9c44fb1320baf49d6d44c3c609efe78b53771304 100644 (file)
@@ -63,16 +63,16 @@ The :mod:`functools` module defines the following functions:
    :attr:`__wrapped__` attribute.  This is useful for introspection, for
    bypassing the cache, or for rewrapping the function with a different cache.
 
-   A `LRU (least recently used) cache
+   An `LRU (least recently used) cache
    <http://en.wikipedia.org/wiki/Cache_algorithms#Least_Recently_Used>`_ works
    best when more recent calls are the best predictors of upcoming calls (for
    example, the most popular articles on a news server tend to change daily).
    The cache's size limit assures that the cache does not grow without bound on
    long-running processes such as web servers.
 
-   Example -- Caching static web content::
+   Example of an LRU cache for static web content::
 
-        @functools.lru_cache(maxsize=20)
+        @lru_cache(maxsize=20)
         def get_pep(num):
             'Retrieve text of a Python Enhancement Proposal'
             resource = 'http://www.python.org/dev/peps/pep-%04d/' % num