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

[Mariatta]

https://github.com/python/cpython/commit/c829bbf68fc4a845b96d3bf30d868f62a5d3332a
commit: c829bbf68fc4a845b96d3bf30d868f62a5d3332a
branch: 2.7
author: Rohit Balasubramanian <brohit23 at outlook.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2017-10-06T22:29:54-07:00
summary:

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

(cherry picked from commit 9e7b9b21fe45f7d93eaf9382fedfa18247d0d2b2)

files:
M Lib/email/utils.py

diff --git a/Lib/email/utils.py b/Lib/email/utils.py
index ac13f49d599..a74db42286e 100644
--- a/Lib/email/utils.py
+++ b/Lib/email/utils.py
@@ -211,6 +211,12 @@ def parsedate_tz(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 '', ''