[tor-commits] [bridgedb/develop] Fix ivar and incomplete items in email.server.MailContext docstring.

[isis at torproject.org]

commit bb50b474c3f16c1061498b183f68d7846c58b1cc
Author: Isis Lovecruft <isis at torproject.org>
Date:   Tue May 27 22:23:10 2014 +0000

    Fix ivar and incomplete items in email.server.MailContext docstring.
---
 lib/bridgedb/email/server.py |   43 ++++++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 20 deletions(-)

diff --git a/lib/bridgedb/email/server.py b/lib/bridgedb/email/server.py
index dbc0c67..c0ea273 100644
--- a/lib/bridgedb/email/server.py
+++ b/lib/bridgedb/email/server.py
@@ -189,32 +189,35 @@ def generateResponse(fromAddress, clientAddress, body, subject=None,
 
 
 class MailContext(object):
-    """Helper object that holds information used by email subsystem."""
+    """Helper object that holds information used by email subsystem.
+
+    :ivar str username: Reject any RCPT TO lines that aren't to this
+        user. See the ``EMAIL_USERNAME`` option in the config file.
+        (default: ``'bridges'``)
+    :ivar int maximumSize: Reject any incoming emails longer than
+        this size (in bytes). (default: 3084 bytes).
+    :ivar int smtpPort: The port to use for outgoing SMTP.
+    :ivar str smtpServer: The IP address to use for outgoing SMTP.
+    :ivar str smtpFromAddr: Use this address in the raw SMTP ``MAIL FROM``
+        line for outgoing mail. (default: ``bridges at torproject.org``)
+    :ivar str fromAddr: Use this address in the email :header:`From:`
+        line for outgoing mail. (default: ``bridges at torproject.org``)
+    :ivar int nBridges: The number of bridges to send for each email.
+    :ivar gpgContext: A ``gpgme.GpgmeContext`` (as created by
+        :func:`bridgedb.crypto.getGPGContext`), or None if we couldn't create
+        a proper GPGME context for some reason.
+    """
 
     def __init__(self, config, distributor, schedule):
-        """DOCDOC
-
-        :ivar str username: Reject any RCPT TO lines that aren't to this
-            user. See the ``EMAIL_USERNAME`` option in the config file.
-            (default: ``'bridges'``)
-        :ivar int maximumSize: Reject any incoming emails longer than
-            this size (in bytes). (default: 3084 bytes).
-        :ivar int smtpPort: The port to use for outgoing SMTP.
-        :ivar str smtpServer: The IP address to use for outgoing SMTP.
-        :ivar str smtpFromAddr: Use this address in the raw SMTP ``MAIL FROM``
-            line for outgoing mail. (default: ``bridges at torproject.org``)
-        :ivar str fromAddr: Use this address in the email :header:`From:`
-            line for outgoing mail. (default: ``bridges at torproject.org``)
-        :ivar int nBridges: The number of bridges to send for each email.
-        :ivar gpgContext: A ``gpgme.GpgmeContext`` (as created by
-            :func:`bridgedb.crypto.getGPGContext`), or None if we couldn't
-            create a proper GPGME context for some reason.
+        """Create a context for storing configs for email bridge distribution.
 
         :type config: :class:`bridgedb.persistent.Conf`
         :type distributor: :class:`bridgedb.Dist.EmailBasedDistributor`.
-        :param distributor: DOCDOC
+        :param distributor: The distributor will handle getting the correct
+            bridges (or none) for a client for us.
         :type schedule: :class:`bridgedb.schedule.ScheduledInterval`.
-        :param schedule: DOCDOC
+        :param schedule: An interval-based scheduler, used to help the
+            :ivar:`distributor` know if we should give bridges to a client.
         """
         self.config = config
         self.distributor = distributor