Update README not to specify the wrong type for the SMTP server - #72
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 referencesmtpd.SMTPServer. Instead, it's a bit vague about what kind of SMTP server is provided, only promising an API "similar tosmtpd.SMTPServer". This gives us freedom to change the exact API offered by that class if necessary.Closes #51