Skip to content

Commit 5b87000

Browse files
committed
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.
1 parent 881ccaf commit 5b87000

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ poking around in the code itself.
132132
is the same as ``httpserver`` only with SSL encryption.
133133

134134
``smtpserver``
135-
provides a threaded instance of ``smtpd.SMTPServer`` running on localhost.
135+
provides a threaded SMTP server, with an API similar to ``smtpd.SMTPServer``,
136+
(the deprecated class from the Python standard library) running on localhost.
136137
It has the following attributes:
137138

138139
* ``addr`` - server address as tuple (host as str, port as int)

0 commit comments

Comments
 (0)