summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Rittau <srittau@rittau.org>2018-09-10 17:29:43 (GMT)
committerBenjamin Peterson <benjamin@python.org>2018-09-10 17:29:43 (GMT)
commit78deb7f33227972987722bc3fed5bcb45fae869e (patch)
treecf52475d38ce03d15a0ed669aa57b5a69d986522
parent9797b7ae4496627836c55333765e10201a9840e3 (diff)
downloadcpython-78deb7f33227972987722bc3fed5bcb45fae869e.zip
cpython-78deb7f33227972987722bc3fed5bcb45fae869e.tar.gz
cpython-78deb7f33227972987722bc3fed5bcb45fae869e.tar.bz2
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
-rw-r--r--Doc/library/smtplib.rst4
-rwxr-xr-xLib/smtplib.py2
2 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst
index 8052172..6fb0934 100644
--- a/Doc/library/smtplib.rst
+++ b/Doc/library/smtplib.rst
@@ -346,7 +346,7 @@ An :class:`SMTP` instance has the following methods:
If optional keyword argument *initial_response_ok* is true,
``authobject()`` will be called first with no argument. It can return the
- :rfc:`4954` "initial response" bytes which will be encoded and sent with
+ :rfc:`4954` "initial response" ASCII ``str`` which will be encoded and sent with
the ``AUTH`` command as below. If the ``authobject()`` does not support an
initial response (e.g. because it requires a challenge), it should return
``None`` when called with ``challenge=None``. If *initial_response_ok* is
@@ -355,7 +355,7 @@ An :class:`SMTP` instance has the following methods:
If the initial response check returns ``None``, or if *initial_response_ok* is
false, ``authobject()`` will be called to process the server's challenge
response; the *challenge* argument it is passed will be a ``bytes``. It
- should return ``bytes`` *data* that will be base64 encoded and sent to the
+ should return ASCII ``str`` *data* that will be base64 encoded and sent to the
server.
The ``SMTP`` class provides ``authobjects`` for the ``CRAM-MD5``, ``PLAIN``,
diff --git a/Lib/smtplib.py b/Lib/smtplib.py
index 048c6bf..5e1bc0b 100755
--- a/Lib/smtplib.py
+++ b/Lib/smtplib.py
@@ -615,7 +615,7 @@ class SMTP:
It will be called to process the server's challenge response; the
challenge argument it is passed will be a bytes. It should return
- bytes data that will be base64 encoded and sent to the server.
+ an ASCII string that will be base64 encoded and sent to the server.
Keyword arguments:
- initial_response_ok: Allow sending the RFC 4954 initial-response