Preparing to package a distribution - add a module docstring and

__version__ info.

14 files changed, 86 insertions, 8 deletions

diff --git a/Mailman/HTMLFormatter.py b/Mailman/HTMLFormatter.py
index 625df296a..018113624 100644
--- a/Mailman/HTMLFormatter.py
+++ b/Mailman/HTMLFormatter.py
@@ -1,3 +1,8 @@
+"""Routines for presentation of list-specific HTML text."""
+
+__version__ = "$Revision: 399 $"
+
+
 import os
 import regsub 
 import string
diff --git a/Mailman/Mailbox.py b/Mailman/Mailbox.py
index 503ad9e15..580f1f290 100644
--- a/Mailman/Mailbox.py
+++ b/Mailman/Mailbox.py
@@ -1,3 +1,8 @@
+"Extend mailbox.UnixMailbox."
+
+__version__ = "$Revision: 399 $"
+
+
 import mailbox
 
 class Mailbox(mailbox.UnixMailbox):
diff --git a/Mailman/Message.py b/Mailman/Message.py
index 61ac922b6..3157e59bb 100644
--- a/Mailman/Message.py
+++ b/Mailman/Message.py
@@ -1,3 +1,8 @@
+"""Embody incoming and outgoing messages as objects."""
+
+__version__ = "$Revision: 399 $"
+
+
 import sys
 import rfc822, string, time
 
diff --git a/Mailman/SecurityManager.py b/Mailman/SecurityManager.py
index e08f702c7..21b3b8263 100644
--- a/Mailman/SecurityManager.py
+++ b/Mailman/SecurityManager.py
@@ -1,3 +1,8 @@
+"""Handle passwords and sanitize approved messages."""
+
+__version__ = "$Revision: 399 $"
+
+
 import crypt, types, string, os
 import mm_err, mm_utils, mm_cfg
 
diff --git a/Mailman/Utils.py b/Mailman/Utils.py
index 87976adce..4cc2d88ae 100644
--- a/Mailman/Utils.py
+++ b/Mailman/Utils.py
@@ -1,3 +1,13 @@
+"""Miscellaneous essential routines.
+
+This inncludes actual message transmission routines, address checking and
+message and address munging, a handy-dandy routine to map a function on all 
+the maillists, the Logging routines, and whatever else doesn't belong
+elsewhere."""
+
+__version__ = "$Revision: 399 $"
+
+
 import sys, string, fcntl, os, random, regsub, re
 import mm_cfg
 
diff --git a/modules/mm_html.py b/modules/mm_html.py
index 625df296a..018113624 100644
--- a/modules/mm_html.py
+++ b/modules/mm_html.py
@@ -1,3 +1,8 @@
+"""Routines for presentation of list-specific HTML text."""
+
+__version__ = "$Revision: 399 $"
+
+
 import os
 import regsub 
 import string
diff --git a/modules/mm_mbox.py b/modules/mm_mbox.py
index 503ad9e15..580f1f290 100644
--- a/modules/mm_mbox.py
+++ b/modules/mm_mbox.py
@@ -1,3 +1,8 @@
+"Extend mailbox.UnixMailbox."
+
+__version__ = "$Revision: 399 $"
+
+
 import mailbox
 
 class Mailbox(mailbox.UnixMailbox):
diff --git a/modules/mm_message.py b/modules/mm_message.py
index 61ac922b6..3157e59bb 100644
--- a/modules/mm_message.py
+++ b/modules/mm_message.py
@@ -1,3 +1,8 @@
+"""Embody incoming and outgoing messages as objects."""
+
+__version__ = "$Revision: 399 $"
+
+
 import sys
 import rfc822, string, time
 
diff --git a/modules/mm_security.py b/modules/mm_security.py
index e08f702c7..21b3b8263 100644
--- a/modules/mm_security.py
+++ b/modules/mm_security.py
@@ -1,3 +1,8 @@
+"""Handle passwords and sanitize approved messages."""
+
+__version__ = "$Revision: 399 $"
+
+
 import crypt, types, string, os
 import mm_err, mm_utils, mm_cfg
 
diff --git a/modules/mm_utils.py b/modules/mm_utils.py
index 87976adce..4cc2d88ae 100644
--- a/modules/mm_utils.py
+++ b/modules/mm_utils.py
@@ -1,3 +1,13 @@
+"""Miscellaneous essential routines.
+
+This inncludes actual message transmission routines, address checking and
+message and address munging, a handy-dandy routine to map a function on all 
+the maillists, the Logging routines, and whatever else doesn't belong
+elsewhere."""
+
+__version__ = "$Revision: 399 $"
+
+
 import sys, string, fcntl, os, random, regsub, re
 import mm_cfg
 
diff --git a/scripts/mailcmd b/scripts/mailcmd
index 2e0751ee0..7b2cc9f75 100755
--- a/scripts/mailcmd
+++ b/scripts/mailcmd
@@ -7,6 +7,9 @@ of the target mailing list.
 
 Errors are redirected to logs/errors."""
 
+__version__ = "$Revision: 399 $"
+
+
 import sys
 
 sys.path.append('/home/mailman/mailman/modules')
diff --git a/scripts/mailowner b/scripts/mailowner
index 746dc8008..3d1556e81 100755
--- a/scripts/mailowner
+++ b/scripts/mailowner
@@ -1,8 +1,14 @@
 #! /usr/local/bin/python 
-# 
-# This script gets called by the wrapper.
-# Stdin is the mail message, and argv[1] is the name of the mailing list
-# whose owner(s) to send mail to.
+
+"""Send a message to the maillist owner.
+
+This script gets called by the wrapper.
+
+Stdin is the mail message, and argv[1] is the name of the mailing list
+whose owner(s) to send mail to."""
+
+__version__ = "$Revision: 399 $"
+
 
 import sys
 f = open('/tmp/owner.errs', 'a+')
diff --git a/scripts/owner b/scripts/owner
index 746dc8008..3d1556e81 100755
--- a/scripts/owner
+++ b/scripts/owner
@@ -1,8 +1,14 @@
 #! /usr/local/bin/python 
-# 
-# This script gets called by the wrapper.
-# Stdin is the mail message, and argv[1] is the name of the mailing list
-# whose owner(s) to send mail to.
+
+"""Send a message to the maillist owner.
+
+This script gets called by the wrapper.
+
+Stdin is the mail message, and argv[1] is the name of the mailing list
+whose owner(s) to send mail to."""
+
+__version__ = "$Revision: 399 $"
+
 
 import sys
 f = open('/tmp/owner.errs', 'a+')
diff --git a/scripts/request b/scripts/request
index 2e0751ee0..7b2cc9f75 100755
--- a/scripts/request
+++ b/scripts/request
@@ -7,6 +7,9 @@ of the target mailing list.
 
 Errors are redirected to logs/errors."""
 
+__version__ = "$Revision: 399 $"
+
+
 import sys
 
 sys.path.append('/home/mailman/mailman/modules')