This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author lorenzo.ancora
Recipients berker.peksag, docs@python, giampaolo.rodola, lorenzo.ancora, terry.reedy
Date 2016-02-07.00:03:44
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1454803424.76.0.210909666577.issue26209@psf.upfronthosting.co.za>
In-reply-to
Content
(msg259748) ok, then I propose to correct https://docs.python.org/dev/library/smtpd.html?highlight=q#smtpd.SMTPServer from:

.. class:: SMTPServer(localaddr, remoteaddr, data_size_limit=33554432,\
                      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.


To:


.. class:: SMTPServer(localaddr, remoteaddr, data_size_limit=33554432,\
                      map=None, enable_SMTPUTF8=False, decode_data=True)

   Creates a new :class:`SMTPServer` object, which binds to local address
   *localaddr* and uses *remoteaddr* as an upstream SMTP relayer.
   Both parameters should be a tuple in the form ``("host", portnumber)``, where *host* is a valid IP/FQDN.
   The object will insert itself into :mod:`asyncore`'s event loop on instantiation (inherits from :class:`asyncore.dispatcher`) and can be started with a call to :class:`asyncore.loop`.

---

These clarifications should be also inserted in the source code as heredocs (without the Sphynx syntax).
I really think that those changes will make the use of smtpd easier.
History
Date User Action Args
2016-02-07 00:03:44lorenzo.ancorasetrecipients: + lorenzo.ancora, terry.reedy, giampaolo.rodola, docs@python, berker.peksag
2016-02-07 00:03:44lorenzo.ancorasetmessageid: <1454803424.76.0.210909666577.issue26209@psf.upfronthosting.co.za>
2016-02-07 00:03:44lorenzo.ancoralinkissue26209 messages
2016-02-07 00:03:44lorenzo.ancoracreate