diff options
| author | Jürgen Gmach <juergen.gmach@googlemail.com> | 2020-06-19 11:57:30 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-19 11:57:30 (GMT) |
| commit | 66a65ba43cb3e68a43e32469c988dd7a6cff049c (patch) | |
| tree | e6c7c83b05b975685df075f4acbe46b631bac755 /Lib/email | |
| parent | 310f6aa7db8dd48952ed718111ce0f016b1c8ef9 (diff) | |
| download | cpython-66a65ba43cb3e68a43e32469c988dd7a6cff049c.zip cpython-66a65ba43cb3e68a43e32469c988dd7a6cff049c.tar.gz cpython-66a65ba43cb3e68a43e32469c988dd7a6cff049c.tar.bz2 | |
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
Diffstat (limited to 'Lib/email')
| -rw-r--r-- | Lib/email/utils.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Lib/email/utils.py b/Lib/email/utils.py index b137ce3..1a7719d 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'. |