[Python-checkins] cpython (3.5): #26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs.

[r.david.murray]

https://hg.python.org/cpython/rev/1ed37f6e91bb
changeset:   103233:1ed37f6e91bb
branch:      3.5
parent:      103231:3bf2f6818719
user:        R David Murray <rdmurray at bitdance.com>
date:        Wed Sep 07 14:01:23 2016 -0400
summary:
  #26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs.

files:
  Doc/library/smtpd.rst  |  7 ++++---
  Doc/library/socket.rst |  2 ++
  2 files changed, 6 insertions(+), 3 deletions(-)


diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst
--- a/Doc/library/smtpd.rst
+++ b/Doc/library/smtpd.rst
@@ -32,9 +32,10 @@
                       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
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -63,6 +63,8 @@
    .. 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'``,

-- 
Repository URL: https://hg.python.org/cpython