From 98bd08819031ae705659a4433cebaea58b449a43 Mon Sep 17 00:00:00 2001 From: Wayne Werner Date: Thu, 12 Oct 2023 18:47:13 -0500 Subject: [PATCH 1/3] Fix typo Rationale is an explantio, rational means "consistent with reason" --- aiosmtpd/docs/NEWS.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aiosmtpd/docs/NEWS.rst b/aiosmtpd/docs/NEWS.rst index 9144b855..ad9090ab 100644 --- a/aiosmtpd/docs/NEWS.rst +++ b/aiosmtpd/docs/NEWS.rst @@ -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 From 552568553cf875045458c8716c81c7ce6691937b Mon Sep 17 00:00:00 2001 From: Wayne Werner Date: Thu, 12 Oct 2023 18:49:52 -0500 Subject: [PATCH 2/3] Slight doc improvements See #320 --- aiosmtpd/docs/concepts.rst | 2 ++ aiosmtpd/docs/intro.rst | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/aiosmtpd/docs/concepts.rst b/aiosmtpd/docs/concepts.rst index 863eb5e6..8a1f739d 100644 --- a/aiosmtpd/docs/concepts.rst +++ b/aiosmtpd/docs/concepts.rst @@ -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 ` or :ref:`programmatically `. diff --git a/aiosmtpd/docs/intro.rst b/aiosmtpd/docs/intro.rst index 808920d6..4e8654e1 100644 --- a/aiosmtpd/docs/intro.rst +++ b/aiosmtpd/docs/intro.rst @@ -9,7 +9,11 @@ Simple Mail Transfer Protocol (SMTP) and Local Mail Transfer Protocol (LMTP). It is derived from `Python 3.5's 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 +`, following `PEP 594 +`, aiosmtpd is the recommended +replacement. Inspiration for this library comes from several other packages: From bb2d97fe0536fd2e842e766a55134b3affbf3380 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sviatoslav=20Sydorenko=20=28=D0=A1=D0=B2=D1=8F=D1=82=D0=BE?= =?UTF-8?q?=D1=81=D0=BB=D0=B0=D0=B2=20=D0=A1=D0=B8=D0=B4=D0=BE=D1=80=D0=B5?= =?UTF-8?q?=D0=BD=D0=BA=D0=BE=29?= Date: Tue, 30 Jan 2024 23:08:48 +0100 Subject: [PATCH 3/3] Update RST syntax for linking CPython docs and PEPs --- aiosmtpd/docs/intro.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/aiosmtpd/docs/intro.rst b/aiosmtpd/docs/intro.rst index 4e8654e1..35f213cf 100644 --- a/aiosmtpd/docs/intro.rst +++ b/aiosmtpd/docs/intro.rst @@ -11,8 +11,7 @@ Local Mail Transfer Protocol (LMTP). It is derived from standard library module, and provides both a command line interface and an API for use in testing applications that send email. Since the `smtpd module was removed in Python 3.12 -`, following `PEP 594 -`, aiosmtpd is the recommended +`__, following :pep:`594#smtpd`, aiosmtpd is the recommended replacement. Inspiration for this library comes from several other packages: