From: Rohit Balasubramanian <brohit23@outlook.com>
Date: Sat, 7 Oct 2017 05:27:36 +0000 (+0530)
Subject: bpo-31507 Add docstring to parseaddr function in email.utils.parseaddr (GH-3647)... 
X-Git-Tag: v3.6.4rc1~182
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=93c0885dc84381cbbb970402b1a21bf690ee312c;p=thirdparty%2FPython%2Fcpython.git

bpo-31507 Add docstring to parseaddr function in email.utils.parseaddr (GH-3647) (GH-3733)

(cherry picked from commit 9e7b9b21fe45f7d93eaf9382fedfa18247d0d2b2)
---

diff --git a/Lib/email/utils.py b/Lib/email/utils.py
index a759d23308d3..e2bfb362c6e7 100644
--- a/Lib/email/utils.py
+++ b/Lib/email/utils.py
@@ -215,6 +215,12 @@ def parsedate_to_datetime(data):
 
 
 def parseaddr(addr):
+    """
+    Parse addr into its constituent realname and email address parts.
+    
+    Return a tuple of realname and email address, unless the parse fails, in
+    which case return a 2-tuple of ('', '').
+    """
     addrs = _AddressList(addr).addresslist
     if not addrs:
         return '', ''