Added module docstrings to all modules.

Author: Jürgen Hermann

roundup/cgi_client.py

@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: cgi_client.py,v 1.60 2001-11-21 22:57:28 jhermann Exp $
+# $Id: cgi_client.py,v 1.61 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+WWW request handler (also used in the stand-alone server).
+"""
 
 import os, cgi, pprint, StringIO, urlparse, re, traceback, mimetypes
 import binascii, Cookie, time
@@ -978,6 +982,10 @@ def parsePropsFromForm(db, cl, form, nodeid=0):
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.60  2001/11/21 22:57:28  jhermann
+# Added dummy hooks for I18N and some preliminary (test) markup of
+# translatable messages
+#
 # Revision 1.59  2001/11/21 03:21:13  richard
 # oops
 #

roundup/cgitb.py

@@ -1,7 +1,11 @@
 #
 # This module was written by Ka-Ping Yee, <[email protected]>.
 # 
-# $Id: cgitb.py,v 1.6 2001-09-29 13:27:00 richard Exp $
+# $Id: cgitb.py,v 1.7 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Extended CGI traceback handler by Ka-Ping Yee, <[email protected]>.
+"""
 
 import sys, os, types, string, keyword, linecache, tokenize, inspect, pydoc
 
@@ -118,6 +122,10 @@ def handler():
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.6  2001/09/29 13:27:00  richard
+# CGI interfaces now spit up a top-level index of all the instances they can
+# serve.
+#
 # Revision 1.5  2001/08/07 00:24:42  richard
 # stupid typo
 #

roundup/date.py

@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: date.py,v 1.13 2001-09-18 22:58:37 richard Exp $
+# $Id: date.py,v 1.14 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Date, time and time interval handling.
+"""
 
 import time, re, calendar
 
@@ -379,6 +383,10 @@ def test():
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.13  2001/09/18 22:58:37  richard
+#
+# Added some more help to roundu-admin
+#
 # Revision 1.12  2001/08/17 03:08:11  richard
 # fixed prettification of intervals of 1 week
 #

roundup/htmltemplate.py

@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: htmltemplate.py,v 1.44 2001-11-21 23:35:45 jhermann Exp $
+# $Id: htmltemplate.py,v 1.45 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Template engine.
+"""
 
 import os, re, StringIO, urllib, cgi, errno
 
@@ -861,6 +865,9 @@ def render(self, form):
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.44  2001/11/21 23:35:45  jhermann
+# Added globbing for win32, and sample marking in a 2nd file to test it
+#
 # Revision 1.43  2001/11/21 04:04:43  richard
 # *sigh* more missing value handling
 #

roundup/hyperdb.py

@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: hyperdb.py,v 1.34 2001-11-21 04:04:43 richard Exp $
+# $Id: hyperdb.py,v 1.35 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Hyperdatabase implementation, especially field types.
+"""
 
 # standard python modules
 import cPickle, re, string
@@ -860,6 +864,9 @@ def Choice(name, *options):
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.34  2001/11/21 04:04:43  richard
+# *sigh* more missing value handling
+#
 # Revision 1.33  2001/11/21 03:40:54  richard
 # more new property handling
 #

roundup/i18n.py

@@ -15,9 +15,9 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: i18n.py,v 1.1 2001-11-21 22:57:29 jhermann Exp $
+# $Id: i18n.py,v 1.2 2001-11-22 15:46:42 jhermann Exp $
 
-"""
+__doc__ = """
 RoundUp Internationalization (I18N)
 
 To use this module, the following code should be used:

roundup/init.py

@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: init.py,v 1.17 2001-11-12 23:17:38 jhermann Exp $
+# $Id: init.py,v 1.18 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Init (create) a roundup instance.
+"""
 
 import os, sys, errno
 
@@ -104,6 +108,9 @@ def init(instance_home, template, backend, adminpw):
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.17  2001/11/12 23:17:38  jhermann
+# Code using copyDigestedFile() that passes unit tests
+#
 # Revision 1.16  2001/10/09 07:25:59  richard
 # Added the Password property type. See "pydoc roundup.password" for
 # implementation details. Have updated some of the documentation too.

roundup/install_util.py

@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: install_util.py,v 1.5 2001-11-12 23:17:38 jhermann Exp $
+# $Id: install_util.py,v 1.6 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Support module to generate and check fingerprints of installed files.
+"""
 
 import os, sha, shutil
 
@@ -145,6 +149,9 @@ def test():
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.5  2001/11/12 23:17:38  jhermann
+# Code using copyDigestedFile() that passes unit tests
+#
 # Revision 1.4  2001/11/12 23:14:40  jhermann
 # Copy function, and proper handling of unknown file types
 #

roundup/instance.py

@@ -15,9 +15,12 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: instance.py,v 1.4 2001-11-12 22:01:06 richard Exp $
+# $Id: instance.py,v 1.5 2001-11-22 15:46:42 jhermann Exp $
 
-''' Currently this module provides one function: open. This function opens
+__doc__ = '''
+Instance handling (open instance).
+
+Currently this module provides one function: open. This function opens
 an instance.
 '''
 
@@ -52,6 +55,9 @@ def open(self, instance_home):
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.4  2001/11/12 22:01:06  richard
+# Fixed issues with nosy reaction and author copies.
+#
 # Revision 1.3  2001/08/07 00:24:42  richard
 # stupid typo
 #

roundup/mailgw.py

@@ -14,8 +14,9 @@
 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-# 
-'''
+#
+
+__doc__ = '''
 An e-mail gateway for Roundup.
 
 Incoming messages are examined for multiple parts:
@@ -72,7 +73,7 @@ class node. Any parts of other types are each stored in separate files
 an exception, the original message is bounced back to the sender with the
 explanatory message given in the exception. 
 
-$Id: mailgw.py,v 1.34 2001-11-15 10:24:27 richard Exp $
+$Id: mailgw.py,v 1.35 2001-11-22 15:46:42 jhermann Exp $
 '''
 
 
@@ -521,6 +522,9 @@ def parseContent(content, blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.34  2001/11/15 10:24:27  richard
+# handle the case where there is no file attached
+#
 # Revision 1.33  2001/11/13 21:44:44  richard
 #  . re-open the database as the author in mail handling
 #