[gsoc-admin] EmailTemplate.__init__: Add documentation



commit 398f589271363120ad1923fc2f68f6b3548ba997
Author: Lasse Schuirmann <lasse schuirmann gmail com>
Date:   Wed Aug 12 21:20:52 2015 +0200

    EmailTemplate.__init__: Add documentation
    
    Parameters are a bit weird but it's simpler this way and can be easily
    changed later. However we should at least document that.

 maillib/email.py |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)
---
diff --git a/maillib/email.py b/maillib/email.py
index 437ab86..e836c8b 100755
--- a/maillib/email.py
+++ b/maillib/email.py
@@ -32,6 +32,15 @@ class Contact:
 
 class EmailTemplate:
     def __init__(self, text, sender, recipients, cc="", bcc=""):
+        """
+        Creates a new mail template.
+
+        :param text:       The text with data fields marked like {key}.
+        :param sender:     The mail adress of the sender (string).
+        :param recipients: A list of Contact objects.
+        :param cc:         The mail adress(es) to CC (string).
+        :param bcc:        The mail adress(es) to BCC (string).
+        """
         self.text = text
         self.sender = sender
         self.recipients = recipients


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]