[Python-checkins] (no subject)

Fri Jun 19 07:57:40 EDT 2020

To: python-checkins at python.org
Subject: Improve readability of `formataddr` docstring (GH-20963)
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
https://github.com/python/cpython/commit/66a65ba43cb3e68a43e32469c988dd7a6cff=
049c
commit: 66a65ba43cb3e68a43e32469c988dd7a6cff049c
branch: master
author: J=C3=BCrgen Gmach <juergen.gmach at googlemail.com>
committer: GitHub <noreply at github.com>
date: 2020年06月19日T04:57:30-07:00
summary:
Improve readability of `formataddr` docstring (GH-20963)
For me as a non native English speaker, the sentence with its embedded clause=
 was very hard to understand.
modified: Lib/email/utils.py
Automerge-Triggered-By: @csabella
files:
M Lib/email/utils.py

diff --git a/Lib/email/utils.py b/Lib/email/utils.py
index b137ce3973a4b..1a7719dbc4898 100644
--- a/Lib/email/utils.py
+++ b/Lib/email/utils.py
@@ -81,7 +81,7 @@ def formataddr(pair, charset=3D'utf-8'):
 If the first element of pair is false, then the second element is
 returned unmodified.
=20
- Optional charset if given is the character set that is used to encode
+ The optional charset is the character set that is used to encode
 realname in case realname is not ASCII safe. Can be an instance of str =
or
 a Charset-like object which has a header_encode method. Default is
 'utf-8'.
