[Zope-Checkins] CVS: Zope/lib/python/Products/StandardCacheManagers - RAMCacheManager.py:1.12

[Paul Winkler]

Update of /cvs-repository/Zope/lib/python/Products/StandardCacheManagers
In directory cvs.zope.org:/tmp/cvs-serv9744/StandardCacheManagers

Modified Files:
	RAMCacheManager.py 
Log Message:

expanded docs (and docstring) to help people
avoid user error such as collector #724


=== Zope/lib/python/Products/StandardCacheManagers/RAMCacheManager.py 1.11 => 1.12 ===
--- Zope/lib/python/Products/StandardCacheManagers/RAMCacheManager.py:1.11	Thu Jan 15 17:54:11 2004
+++ Zope/lib/python/Products/StandardCacheManagers/RAMCacheManager.py	Thu Apr 29 16:06:22 2004
@@ -323,7 +323,22 @@
 PRODUCT_DIR = __name__.split('.')[-2]
 
 class RAMCacheManager (CacheManager, SimpleItem):
-    ' '
+    """Manage a RAMCache, which stores rendered data in RAM. 
+
+    This is intended to be used as a low-level cache for
+    expensive Python code, not for objects published
+    under their own URLs such as web pages.
+
+    RAMCacheManager *can* be used to cache complete publishable
+    pages, such as DTMLMethods/Documents and Page Templates, 
+    but this is not advised: such objects typically do not attempt
+    to cache important out-of-band data such as 3xx HTTP responses,
+    and the client would get an erroneous 200 response.
+
+    Such objects should instead be cached with an                             
+    AcceleratedHTTPCacheManager and/or downstream                               
+    caching.
+    """
 
     __ac_permissions__ = (
         ('View management screens', ('getSettings',