[Zope-Checkins] CVS: Zope/lib/python/Products/TemporaryFolder - TemporaryFolder.py:1.6

Chris McDonough chrism@zope.com
Mon, 12 Aug 2002 17:14:15 -0400


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

Modified Files:
	TemporaryFolder.py 
Log Message:
Add explanatory docs to source as a docstring.


=== Zope/lib/python/Products/TemporaryFolder/TemporaryFolder.py 1.5 => 1.6 ===
--- Zope/lib/python/Products/TemporaryFolder/TemporaryFolder.py:1.5	Mon Mar 11 11:09:19 2002
+++ Zope/lib/python/Products/TemporaryFolder/TemporaryFolder.py	Mon Aug 12 17:14:15 2002
@@ -10,9 +10,20 @@
 # FOR A PARTICULAR PURPOSE
 # 
 ##############################################################################
-"""Mounted database support
+"""
+Mounted database support
 
-$Id$"""
+A MountedTemporaryFolder is an object that is a mount point.  It mounts a
+TemporaryStorage-backed database and masquerades as its root object.
+When you traverse one of these things, the __of__ method of the mount
+point object is called, and that returns a Folder object that actually
+lives in another ZODB.
+
+To understand this fully, you'll need to read the source of
+ZODB.Mount.MountPoint.
+
+$Id$
+"""
 __version__='$Revision$'[11:-2]
 
 import Globals