Skip to content

Commit

Permalink
Merge: python#26209: Clarify type of *localaddr*/*remoteadr* in smtpd…
Browse files Browse the repository at this point in the history
… docs.
  • Loading branch information
bitdancer committed Sep 7, 2016
2 parents 91afe7e + 6b46ec7 commit 2195d53
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Doc/library/smtpd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ SMTPServer Objects
map=None, enable_SMTPUTF8=False, decode_data=False)

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
Expand Down
2 changes: 2 additions & 0 deletions Doc/library/socket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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'``,
Expand Down

0 comments on commit 2195d53

Please sign in to comment.