]> granicus.if.org Git - python/commitdiff
#26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs.
authorR David Murray <rdmurray@bitdance.com>
Wed, 7 Sep 2016 18:01:23 +0000 (14:01 -0400)
committerR David Murray <rdmurray@bitdance.com>
Wed, 7 Sep 2016 18:01:23 +0000 (14:01 -0400)
Doc/library/smtpd.rst
Doc/library/socket.rst

index 977f9a87487977448530bcb03763a77795b241e9..080411b66407104e59447e03705483d1e585f112 100644 (file)
@@ -32,9 +32,10 @@ SMTPServer Objects
                       map=None, enable_SMTPUTF8=False, decode_data=True)
 
    Create a new :class:`SMTPServer` object, which binds to local address
-   *localaddr*.  It will treat *remoteaddr* as an upstream SMTP relayer.  It
-   inherits from :class:`asyncore.dispatcher`, and so will insert itself into
-   :mod:`asyncore`'s event loop on instantiation.
+   *localaddr*.  It will treat *remoteaddr* as an upstream SMTP relayer.  Both
+   *localaddr* and *remoteaddr* should be a :ref:`(host, port) <host_port>`
+   tuple.  The object inherits from :class:`asyncore.dispatcher`, and so will
+   insert itself into :mod:`asyncore`'s event loop on instantiation.
 
    *data_size_limit* specifies the maximum number of bytes that will be
    accepted in a ``DATA`` command.  A value of ``None`` or ``0`` means no
index 02f2350673bb76fa4456b96e8b816e4519cad569..79c7609e54a4ba1d2059189ea096d296ed9352aa 100644 (file)
@@ -63,6 +63,8 @@ created.  Socket addresses are represented as follows:
    .. versionchanged:: 3.5
       Writable :term:`bytes-like object` is now accepted.
 
+.. _host_port:
+
 - A pair ``(host, port)`` is used for the :const:`AF_INET` address family,
   where *host* is a string representing either a hostname in Internet domain
   notation like ``'daring.cwi.nl'`` or an IPv4 address like ``'100.50.200.5'``,