From 0409119d44f36229c63b0be08baa9962f279b6bb Mon Sep 17 00:00:00 2001
From: bwarsaw
Date: Tue, 9 Oct 2001 21:34:59 +0000
Subject: Add a useful comment about what the Stop is for.

---
 Mailman/Bouncers/BouncerAPI.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Mailman/Bouncers/BouncerAPI.py b/Mailman/Bouncers/BouncerAPI.py
index 6b5fafc00..894f2c805 100644
--- a/Mailman/Bouncers/BouncerAPI.py
+++ b/Mailman/Bouncers/BouncerAPI.py
@@ -33,6 +33,10 @@ if __name__ == '__main__':
 
 from Mailman.Logging.Syslog import syslog
 
+# If a bounce detector returns Stop, that means to just discard the message.
+# An example is warning messages for temporary delivery problems.  These
+# shouldn't trigger a bounce notification, but we also don't want to send them
+# on to the list administrator.
 class _Stop:
     pass
 Stop = _Stop()
-- 
cgit v1.3.1