[Zope-CVS] CVS: Packages/zpkgtools/zpkgtools - dependencies.py:1.5

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/zpkgtools/zpkgtools
In directory cvs.zope.org:/tmp/cvs-serv13331

Modified Files:
	dependencies.py 
Log Message:
added documentation


=== Packages/zpkgtools/zpkgtools/dependencies.py 1.4 => 1.5 ===
--- Packages/zpkgtools/zpkgtools/dependencies.py:1.4	Wed Apr  7 23:50:15 2004
+++ Packages/zpkgtools/zpkgtools/dependencies.py	Tue Apr 27 12:14:52 2004
@@ -11,7 +11,15 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Support for handling dependency information."""
+"""Support for handling dependency information.
+
+Dependencies are stored in a file format with one dependency per line.
+Leading and trailing whitespace is ignored.  Blank lines and lines
+with "\#" as the first non-blank character are ignored.  Dependencies
+are identified using resource identifiers; these are normalized using
+the `locationmap.normalizeResourceId()` function.
+
+"""
 
 import sets
 
@@ -19,6 +27,14 @@
 
 
 def load(f):
+    """Load a set of dependencies from an open file.
+
+    :return: A set of dependencies listed in `f`.
+    :rtype: `sets.Set`
+
+    :param f: File object to read from.
+
+    """
     deps = sets.Set()
     for line in f:
         line = line.strip()