classification
Title: smtplib's authobject return value wrongly documented
Type: Stage: resolved
Components: Documentation Versions: Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: benjamin.peterson, docs@python, miss-islington, srittau
Priority: normal Keywords: patch

Created on 2018-08-28 02:10 by srittau, last changed 2018-09-10 18:16 by miss-islington. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 8965 merged srittau, 2018-08-28 02:15
PR 9139 merged miss-islington, 2018-09-10 17:29
PR 9140 merged miss-islington, 2018-09-10 17:30
Messages (4)
msg324209 - (view) Author: Sebastian Rittau (srittau) * Date: 2018-08-28 02:10
smtplib's authobject() callback is supposed to return bytes, according to both the documentation at https://docs.python.org/3/library/smtplib.html as well as the docstring of SMTP.auth(). This does neither match the implementation of auth(), which immediately calls encode() on the return value, nor that of the auth_cram_md5() et al, which return str.
msg324939 - (view) Author: Benjamin Peterson (benjamin.peterson) * (Python committer) Date: 2018-09-10 17:29
New changeset 78deb7f33227972987722bc3fed5bcb45fae869e by Benjamin Peterson (Sebastian Rittau) in branch 'master':
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
https://github.com/python/cpython/commit/78deb7f33227972987722bc3fed5bcb45fae869e
msg324943 - (view) Author: miss-islington (miss-islington) Date: 2018-09-10 18:13
New changeset 011141f312f11b35ac163d9d52fe48e4bb61a814 by Miss Islington (bot) in branch '3.7':
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
https://github.com/python/cpython/commit/011141f312f11b35ac163d9d52fe48e4bb61a814
msg324944 - (view) Author: miss-islington (miss-islington) Date: 2018-09-10 18:16
New changeset c0db8177dc9a7f79941551576e1faea9724e027d by Miss Islington (bot) in branch '3.6':
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
https://github.com/python/cpython/commit/c0db8177dc9a7f79941551576e1faea9724e027d
History
Date User Action Args
2018-09-10 18:16:15miss-islingtonsetmessages: + msg324944
2018-09-10 18:13:17miss-islingtonsetnosy: + miss-islington
messages: + msg324943
2018-09-10 17:30:05miss-islingtonsetpull_requests: + pull_request8590
2018-09-10 17:29:55miss-islingtonsetpull_requests: + pull_request8589
2018-09-10 17:29:46benjamin.petersonsetstatus: open -> closed

nosy: + benjamin.peterson
messages: + msg324939

resolution: fixed
stage: patch review -> resolved
2018-08-28 02:15:52srittausetkeywords: + patch
stage: patch review
pull_requests: + pull_request8438
2018-08-28 02:10:42srittaucreate