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

(cherry picked from commit 9e7b9b21fe45f7d93eaf9382fedfa18247d0d2b2)

diff --git a/Lib/email/utils.py b/Lib/email/utils.py
index a759d23308d3026d485a46b315b796ea1a719f89..e2bfb362c6e77380a357534e5f7e073a5ad1e08f 100644 (file)
--- 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 '', ''