summaryrefslogtreecommitdiff
path: root/Doc/library/smtpd.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2016-09-07 14:01:23 -0400
committerR David Murray <rdmurray@bitdance.com>2016-09-07 14:01:23 -0400
commit6b46ec7733ad7391b9e008d2b273c556f140f88e (patch)
treef3324b5491993850a7649d2a5bf42c7efd4795ae /Doc/library/smtpd.rst
parentc2e2473bc210ff83c2cbc73c4b916893f773b480 (diff)
downloadcpython-git-6b46ec7733ad7391b9e008d2b273c556f140f88e.tar.gz
#26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs.
Diffstat (limited to 'Doc/library/smtpd.rst')
-rw-r--r--Doc/library/smtpd.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst
index 977f9a8748..080411b664 100644
--- a/Doc/library/smtpd.rst
+++ b/Doc/library/smtpd.rst
@@ -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