[Zope3-checkins] SVN: Zope3/branches/ZopeX3-3.0/src/zope/app/publisher/browser/directoryresource.py add some explanation of what a resource directory is

[Fred L. Drake, Jr.]

Log message for revision 26967:
  add some explanation of what a resource directory is


Changed:
  U   Zope3/branches/ZopeX3-3.0/src/zope/app/publisher/browser/directoryresource.py


-=-
Modified: Zope3/branches/ZopeX3-3.0/src/zope/app/publisher/browser/directoryresource.py
===================================================================
--- Zope3/branches/ZopeX3-3.0/src/zope/app/publisher/browser/directoryresource.py	2004-08-09 18:55:24 UTC (rev 26966)
+++ Zope3/branches/ZopeX3-3.0/src/zope/app/publisher/browser/directoryresource.py	2004-08-09 19:00:10 UTC (rev 26967)
@@ -13,6 +13,14 @@
 ##############################################################################
 """Resource Directory
 
+A 'resource directory' is an on-disk directory which is registered as
+a resource using the <resourceDirectory> ZCML directive.  The
+directory is treated as a source for individual resources; it can be
+traversed to retrieve resources represented by contained files, which
+can in turn be treated as resources.  The contained files have
+__name__ values which include a '/' separating the __name__ of the
+resource directory from the name of the file within the directory.
+
 $Id$
 """
 import os