From: Jürgen Gmach <juergen.gmach@googlemail.com>
Date: Fri, 19 Jun 2020 11:57:30 +0000 (+0200)
Subject: Improve readability of `formataddr` docstring (GH-20963)
X-Git-Tag: v3.10.0a1~583
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=66a65ba43cb3e68a43e32469c988dd7a6cff049c;p=thirdparty%2FPython%2Fcpython.git

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
---

diff --git a/Lib/email/utils.py b/Lib/email/utils.py
index b137ce3973a4..1a7719dbc489 100644
--- a/Lib/email/utils.py
+++ b/Lib/email/utils.py
@@ -81,7 +81,7 @@ def formataddr(pair, charset='utf-8'):
     If the first element of pair is false, then the second element is
     returned unmodified.
 
-    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'.