From 5b87000609863c26c2a40f6aab6a448ae608cd62 Mon Sep 17 00:00:00 2001 From: David Zaslavsky Date: Wed, 20 Sep 2023 00:57:56 -0700 Subject: [PATCH] Update README not to specify the wrong type for the SMTP server The README file had said that the SMTP server would be an instance of smtpd.SMTPServer, but that's actually no longer true now that we don't use the smtpd module anymore. In this commit I'm updating that bit of documentation not to specifically reference smtpd.SMTPServer. Instead, it's a bit vague about what kind of SMTP server is provided, only promising an API "similar to smtpd.SMTPServer". This gives us freedom to change the exact API offered by that class if necessary. --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index aa6cbb9..fbaf2bd 100644 --- a/README.rst +++ b/README.rst @@ -132,7 +132,8 @@ poking around in the code itself. is the same as ``httpserver`` only with SSL encryption. ``smtpserver`` - provides a threaded instance of ``smtpd.SMTPServer`` running on localhost. + provides a threaded SMTP server, with an API similar to ``smtpd.SMTPServer``, + (the deprecated class from the Python standard library) running on localhost. It has the following attributes: * ``addr`` - server address as tuple (host as str, port as int)