[tor-commits] [bridgedb/develop] Fix docstring for bridgedb.email.templates.addFooter().

[isis at torproject.org]

commit c82d9cd879a043df2ee68dd6620ee8d842a96ca9
Author: Isis Lovecruft <isis at torproject.org>
Date:   Thu Aug 28 09:46:40 2014 +0000

    Fix docstring for bridgedb.email.templates.addFooter().
---
 lib/bridgedb/email/templates.py |   22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/lib/bridgedb/email/templates.py b/lib/bridgedb/email/templates.py
index 5eb97fb..e4d5389 100644
--- a/lib/bridgedb/email/templates.py
+++ b/lib/bridgedb/email/templates.py
@@ -109,15 +109,23 @@ def addHowto(template):
     return howToTBB
 
 def addFooter(template, clientAddress=None):
-    """Add a footer.
+    """Add a footer::
 
-     --
-     <3 BridgeDB
-    ________________________________________________________________________
-    Public Keys: https://bridges.torproject.org/keys
+        --
+        <3 BridgeDB
+       ________________________________________________________________________
+       Public Keys: https://bridges.torproject.org/keys
 
-    This email was generated with rainbows, unicorns, and sparkles
-    for alice at example.com on Friday, 09 May, 2014 at 18:59:39.
+       This email was generated with rainbows, unicorns, and sparkles
+       for alice at example.com on Friday, 09 May, 2014 at 18:59:39.
+
+
+    :type template: ``gettext.NullTranslation`` or ``gettext.GNUTranslation``
+    :param template: A gettext translations instance, optionally with fallback
+        languages set.
+    :type clientAddress: :api:`twisted.mail.smtp.Address`
+    :param clientAddress: The client's email address which should be in the
+        ``To:`` header of the response email.
     """
     now = datetime.utcnow()
     clientAddr = clientAddress.addrstr