commit c829bbf68fc4a845b96d3bf30d868f62a5d3332a
author Rohit Balasubramanian <brohit23@outlook.com> Sat Oct 07 10:59:54 2017 +0530
committer Mariatta <Mariatta@users.noreply.github.com> Fri Oct 06 22:29:54 2017 -0700
tree c9a26113ede41e5dc1343d1687e1324d9555c972
parent 2fb8e9385944276884c2a2dc5d6275a04e04c879

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

(cherry picked from commit 9e7b9b21fe45f7d93eaf9382fedfa18247d0d2b2)

Lib/email/utils.py

diff --git a/Lib/email/utils.py b/Lib/email/utils.py
index ac13f49..a74db42 100644
--- a/Lib/email/utils.py
+++ b/Lib/email/utils.py
@@ -211,6 +211,12 @@
 
 
 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 '', ''