From 7d090d036546fee25381ecc6ddaddfd26317c9c3 Mon Sep 17 00:00:00 2001
From: jhermann <jhermann@57a73879-2fb5-44c3-a270-3262357dd7e2>
Date: Thu, 22 Nov 2001 15:46:42 +0000
Subject: [PATCH] Added module docstrings to all modules.

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@418 57a73879-2fb5-44c3-a270-3262357dd7e2
---
 roundup/cgi_client.py      | 10 +++++++++-
 roundup/cgitb.py           | 10 +++++++++-
 roundup/date.py            | 10 +++++++++-
 roundup/htmltemplate.py    |  9 ++++++++-
 roundup/hyperdb.py         |  9 ++++++++-
 roundup/i18n.py            |  4 ++--
 roundup/init.py            |  9 ++++++++-
 roundup/install_util.py    |  9 ++++++++-
 roundup/instance.py        | 10 ++++++++--
 roundup/mailgw.py          | 10 +++++++---
 roundup/password.py        | 10 +++++++++-
 roundup/roundupdb.py       | 10 +++++++++-
 roundup/templatebuilder.py |  9 ++++++++-
 13 files changed, 102 insertions(+), 17 deletions(-)

diff --git a/roundup/cgi_client.py b/roundup/cgi_client.py
index 4875f95..4379896 100644
--- a/roundup/cgi_client.py
+++ b/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
 #
diff --git a/roundup/cgitb.py b/roundup/cgitb.py
index 9c9d0ed..cc9217b 100644
--- a/roundup/cgitb.py
+++ b/roundup/cgitb.py
@@ -1,7 +1,11 @@
 #
 # This module was written by Ka-Ping Yee, <ping@lfw.org>.
 # 
-# $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, <ping@lfw.org>.
+"""
 
 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
 #
diff --git a/roundup/date.py b/roundup/date.py
index ef65d87..8382ec3 100644
--- a/roundup/date.py
+++ b/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 @@ if __name__ == '__main__':
 
 #
 # $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
 #
diff --git a/roundup/htmltemplate.py b/roundup/htmltemplate.py
index 9afbd09..040b9a8 100644
--- a/roundup/htmltemplate.py
+++ b/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 @@ class NewItemTemplate(TemplateFunctions):
 
 #
 # $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
 #
diff --git a/roundup/hyperdb.py b/roundup/hyperdb.py
index f19ed35..515ec99 100644
--- a/roundup/hyperdb.py
+++ b/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
 #
diff --git a/roundup/i18n.py b/roundup/i18n.py
index 81edf78..ce69252 100644
--- a/roundup/i18n.py
+++ b/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:
diff --git a/roundup/init.py b/roundup/init.py
index 7bf27e3..efc5712 100644
--- a/roundup/init.py
+++ b/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 @@ from roundup.backends.back_%s import Database'''%backend
 
 #
 # $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.
diff --git a/roundup/install_util.py b/roundup/install_util.py
index ca57d61..8bea4cf 100644
--- a/roundup/install_util.py
+++ b/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 @@ if __name__ == '__main__':
 
 #
 # $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
 #
diff --git a/roundup/instance.py b/roundup/instance.py
index 59c56fb..f2a9eaf 100644
--- a/roundup/instance.py
+++ b/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 @@ del opener
 
 #
 # $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
 #
diff --git a/roundup/mailgw.py b/roundup/mailgw.py
index e0b3ce5..6274173 100644
--- a/roundup/mailgw.py
+++ b/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 @@ are calling the create() method to create a new node). If an auditor raises
 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
 #
diff --git a/roundup/password.py b/roundup/password.py
index 9ae02c6..28c68a1 100644
--- a/roundup/password.py
+++ b/roundup/password.py
@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: password.py,v 1.3 2001-10-20 11:58:48 richard Exp $
+# $Id: password.py,v 1.4 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Password handling (encoding, decoding).
+"""
 
 import sha, re
 
@@ -113,6 +117,10 @@ if __name__ == '__main__':
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.3  2001/10/20 11:58:48  richard
+# Catch errors in login - no username or password supplied.
+# Fixed editing of password (Password property type) thanks Roch'e Compaan.
+#
 # Revision 1.2  2001/10/09 23:58:10  richard
 # Moved the data stringification up into the hyperdb.Class class' get, set
 # and create methods. This means that the data is also stringified for the
diff --git a/roundup/roundupdb.py b/roundup/roundupdb.py
index f6228d9..8f33f1e 100644
--- a/roundup/roundupdb.py
+++ b/roundup/roundupdb.py
@@ -15,7 +15,11 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: roundupdb.py,v 1.18 2001-11-15 10:36:17 richard Exp $
+# $Id: roundupdb.py,v 1.19 2001-11-22 15:46:42 jhermann Exp $
+
+__doc__ = """
+Extending hyperdb with types specific to issue-tracking.
+"""
 
 import re, os, smtplib, socket
 import mimetools, MimeWriter, cStringIO
@@ -389,6 +393,10 @@ Roundup issue tracker
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.18  2001/11/15 10:36:17  richard
+#  . incorporated patch from Roch'e Compaan implementing attachments in nosy
+#     e-mail
+#
 # Revision 1.17  2001/11/12 22:01:06  richard
 # Fixed issues with nosy reaction and author copies.
 #
diff --git a/roundup/templatebuilder.py b/roundup/templatebuilder.py
index cbbd0bf..358cfdc 100644
--- a/roundup/templatebuilder.py
+++ b/roundup/templatebuilder.py
@@ -15,9 +15,13 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: templatebuilder.py,v 1.12 2001-11-14 21:35:21 richard Exp $
+# $Id: templatebuilder.py,v 1.13 2001-11-22 15:46:42 jhermann Exp $
 import errno, re
 
+__doc__ = """
+Collect template parts and create instance template files.
+"""
+
 preamble = """ 
 # Do Not Edit (Unless You Want To)
 # This file automagically generated by roundup.htmldata.makeHtmlBase
@@ -85,6 +89,9 @@ if __name__ == "__main__":
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.12  2001/11/14 21:35:21  richard
+#  . users may attach files to issues (and support in ext) through the web now
+#
 # Revision 1.11  2001/08/07 00:24:42  richard
 # stupid typo
 #
-- 
2.30.2