From 1833e1e51f4994d733c4ef3fca7c6ef7a4fd519e Mon Sep 17 00:00:00 2001
From: Mark Sapiro <mark@msapiro.net>
Date: Fri, 26 Feb 2016 14:02:44 -0800
Subject: Minor documentation clean up.
---
Mailman/Defaults.py.in | 2 +-
Mailman/Utils.py | 9 +++++----
2 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/Mailman/Defaults.py.in b/Mailman/Defaults.py.in
index 4881bbba..06b3e0ad 100755
--- a/Mailman/Defaults.py.in
+++ b/Mailman/Defaults.py.in
@@ -136,7 +136,7 @@ SUBSCRIBE_FORM_MIN_TIME = seconds(5)
# in the installation. This supplements the individual list's ban_list.
# For example, to ban xxx@aol.com and any @gmail.com address beginning with
# yyy, set
-# GLOBAL_BAN_LIST = ['xxx@aol.com', '^yyy.*@gmail\.com']
+# GLOBAL_BAN_LIST = ['xxx@aol.com', '^yyy.*@gmail\.com$']
GLOBAL_BAN_LIST = []
# Command that is used to convert text/html parts into plain text. This
diff --git a/Mailman/Utils.py b/Mailman/Utils.py
index 682f5058..f821f13a 100644
--- a/Mailman/Utils.py
+++ b/Mailman/Utils.py
@@ -1165,8 +1165,8 @@ def suspiciousHTML(html):
s_dict = {}
def get_suffixes(url):
- """This loads the data from the url argument into s_dict for use by
-get_org_dom."""
+ """This loads and parses the data from the url argument into s_dict for
+ use by get_org_dom."""
global s_dict
if s_dict:
return
@@ -1194,14 +1194,15 @@ get_org_dom."""
s_dict[k] = exc
def _get_dom(d, l):
- """A helper to get a domain name consisting of the first l labels in d."""
+ """A helper to get a domain name consisting of the first l+1 labels
+ in d."""
dom = d[:min(l+1, len(d))]
dom.reverse()
return '.'.join(dom)
def get_org_dom(domain):
"""Given a domain name, this returns the corresponding Organizational
-Domain which may be the same as the input."""
+ Domain which may be the same as the input."""
global s_dict
if not s_dict:
get_suffixes(mm_cfg.DMARC_ORGANIZATIONAL_DOMAIN_DATA_URL)
--
cgit v1.2.3