From 2848a090e37f651deda370e3b17dc54f207339a5 Mon Sep 17 00:00:00 2001
From: Stuart Gathman <stuart@gathman.org>
Date: Tue, 28 Jul 2009 22:31:34 +0000
Subject: [PATCH] Document milterContext

---
 Milter/__init__.py |  2 +-
 doc/milter.py      | 13 +++++++++++++
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/Milter/__init__.py b/Milter/__init__.py
index 9b27c95..bac26fa 100755
--- a/Milter/__init__.py
+++ b/Milter/__init__.py
@@ -8,7 +8,7 @@
 # Copyright 2001,2009 Business Management Systems, Inc.
 # This code is under the GNU General Public License.  See COPYING for details.
 
-__version__ = '0.9.2'
+__version__ = '0.9.3'
 
 import os
 import milter
diff --git a/doc/milter.py b/doc/milter.py
index 1da555b..2fe7776 100644
--- a/doc/milter.py
+++ b/doc/milter.py
@@ -6,6 +6,19 @@
 # A thin wrapper around libmilter.
 #
 
+## Hold context for a milter connection.
+# Each connection to sendmail creates a new <code>SMFICTX</code> struct within
+# libmilter.  The milter module in turn creates a milterContext
+# tied to the <code>SMFICTX</code> struct via <code>smfi_setpriv</code>
+# to hold a PyThreadState and a user defined Python object for the connection.
+# 
+# Most application interaction with libmilter takes places via 
+# the milterContext object for the connection.  It is passed to
+# callback functions as the first parameter.
+#
+# The <code>Milter</code> module creates a python class for each connection,
+# and converts function callbacks to instance method invocations.
+#
 class milterContext(object):
   def getsymval(self,sym): pass
   def setreply(self,rcode,xcode,*msg): pass
-- 
GitLab