Skip to content

Small docs change #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Small docs change #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98bd088
Fix typo
waynew Oct 12, 2023
5525685
Slight doc improvements
waynew Oct 12, 2023
bb2d97f
Update RST syntax for linking CPython docs and PEPs
webknjaz Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion aiosmtpd/docs/NEWS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Added

Fixed/Improved
--------------
* All Controllers now have more rationale design, as they are now composited from a Base + a Mixin
* All Controllers now have more rational design, as they are now composited from a Base + a Mixin
* A whole bunch of annotations


Expand Down
2 changes: 2 additions & 0 deletions aiosmtpd/docs/concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Concepts
==========

This guide assumes familiarity with the SMTP protocol.

There are two general ways you can run the SMTP server, via the
:ref:`command line <cli>` or :ref:`programmatically <controller>`.

Expand Down
5 changes: 4 additions & 1 deletion aiosmtpd/docs/intro.rst
View file
Open in desktop
Copy link
Collaborator

@pepoluan pepoluan Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would split the piece of text explaining that we're replacement for smtpd into a separate paragraph, optionally with some kind of highlight / callout.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ Simple Mail Transfer Protocol (SMTP) and
Local Mail Transfer Protocol (LMTP). It is derived from
`Python 3.5's smtpd.py <https://hg.python.org/cpython/file/3.5/Lib/smtpd.py>`__
standard library module, and provides both a command line interface and an API
for use in testing applications that send email.
for use in testing applications that send email. Since the `smtpd module was
removed in Python 3.12
<https://docs.python.org/3.12/whatsnew/3.12.html#locale>`__, following :pep:`594#smtpd`, aiosmtpd is the recommended
replacement.

Inspiration for this library comes from several other packages:

Expand Down