From 61ec968b0d1a3681bbc049d651f67100b64e1f6d Mon Sep 17 00:00:00 2001
From: Christopher Allan Webber <cwebber@dustycloud.org>
Date: Wed, 4 May 2011 08:11:37 -0500
Subject: [PATCH] A simple, maybe obvious, docstring for util.send_email()

---
 mediagoblin/util.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/mediagoblin/util.py b/mediagoblin/util.py
index 5b578a00..d24b59b6 100644
--- a/mediagoblin/util.py
+++ b/mediagoblin/util.py
@@ -142,6 +142,16 @@ def _clear_test_inboxes():
 ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 def send_email(from_addr, to_addrs, subject, message_body):
+    """
+    Simple email sending wrapper, use this so we can capture messages
+    for unit testing purposes.
+
+    Args:
+     - from_addr: address you're sending the email from
+     - to_addrs: list of recipient email addresses
+     - subject: subject of the email
+     - message_body: email body text
+    """
     # TODO: make a mock mhost if testing is enabled
     if TESTS_ENABLED:
         mhost = FakeMhost()