]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Improve readability of `formataddr` docstring (GH-20963)
authorJürgen Gmach <juergen.gmach@googlemail.com>
Fri, 19 Jun 2020 11:57:30 +0000 (13:57 +0200)
committerGitHub <noreply@github.com>
Fri, 19 Jun 2020 11:57:30 +0000 (04:57 -0700)
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
Lib/email/utils.py

index b137ce3973a4b4a1ae7faab2058e4cc03c0cf428..1a7719dbc4898fc328a9b8e792d1d4a603783f77 100644 (file)
@@ -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'.