Mike Bayer avatar Mike Bayer committed 0237d06

add a note about expiration time being local only, #9

Comments (0)

Files changed (1)

dogpile/cache/region.py

          decorator (though note:  **not** the :meth:`.CacheRegion.get` 
          method) will call upon the value creation function after this
          time period has passed since the last generation.
+         
+         .. note:: 
+         
+            The expiration_time is only stored *locally*, 
+            within the :class:`.CacheRegion` instance, and not 
+            in the cache itself.  Only the *creation time* of a 
+            particular value is stored along with it in the cache. 
+            This means an individual :class:`.CacheRegion` can
+            be modified to have a different expiration time, which
+            will have an immediate effect on data in the cache without
+            the need to set new values.
+            
 
         :param arguments:   Optional.  The structure here is passed 
          directly to the constructor of the :class:`.CacheBackend` 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.