diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2020-06-19 05:18:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-19 05:18:44 -0700 |
| commit | 83e54debac6344818bd9ee171314869d0ac024dd (patch) | |
| tree | 13acbf6e8d28373f6deac4fc513c19796d66ce6c /Lib/email | |
| parent | a5442b26f46f1073d1eb78895d554be520105ecb (diff) | |
| download | cpython-git-83e54debac6344818bd9ee171314869d0ac024dd.tar.gz | |
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
(cherry picked from commit 66a65ba43cb3e68a43e32469c988dd7a6cff049c)
Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
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 b137ce3973..1a7719dbc4 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'. |