traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
This commit is contained in:
Jürgen Gmach 2020-06-19 13:57:30 +02:00 committed by GitHub
parent 310f6aa7db
commit 66a65ba43c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Lib/email/utils.py
View File

@ -81,7 +81,7 @@ def formataddr(pair, charset='utf-8'):
If the first element of pair is false, then the second element is If the first element of pair is false, then the second element is
returned unmodified. 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 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 a Charset-like object which has a header_encode method. Default is
'utf-8'. 'utf-8'.