Improve readability of formataddr docstring (GH-20963)

jugmac00 · web-flow · commit 66a65ba43cb3 · 2020-06-19T04:57:30.000-07:00
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
@@ -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'.
