diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2020-06-19 12:15:57 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-19 12:15:57 (GMT) |
| commit | 4dd10ed6942ab99bc5b0b1c5ecc88a753877aefd (patch) | |
| tree | 23b1c0183154979c7622efbabf3efc2468a97dcb /Lib | |
| parent | e8056180a13b6755e4e3e5505b7bf03f79da29fb (diff) | |
| download | cpython-4dd10ed6942ab99bc5b0b1c5ecc88a753877aefd.zip cpython-4dd10ed6942ab99bc5b0b1c5ecc88a753877aefd.tar.gz cpython-4dd10ed6942ab99bc5b0b1c5ecc88a753877aefd.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
(cherry picked from commit 66a65ba43cb3e68a43e32469c988dd7a6cff049c)
Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
Diffstat (limited to 'Lib')
| -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 858f620..07dd029 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'. |