[Emacs-diffs] master 47d52c2 2/3: mail-extr.el: Mention `mail-header-parse-address' in the doc string

[Lars Ingebrigtsen]

branch: master
commit 47d52c22559da40003dcd02ad32097562a8573d5
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    mail-extr.el: Mention `mail-header-parse-address' in the doc string
    
    * lisp/mail/mail-extr.el (mail-extract-address-components):
    Mention `mail-header-parse-address' in the doc string.
---
 lisp/mail/mail-extr.el | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lisp/mail/mail-extr.el b/lisp/mail/mail-extr.el
index 3e8a41f..0175c68 100644
--- a/lisp/mail/mail-extr.el
+++ b/lisp/mail/mail-extr.el
@@ -712,7 +712,13 @@ one recipients, all but the first is ignored.
 ADDRESS may be a string or a buffer.  If it is a buffer, the visible
 \(narrowed) portion of the buffer will be interpreted as the address.
 \(This feature exists so that the clever caller might be able to avoid
-consing a string.)"
+consing a string.)
+
+This function is primarily meant for when you're displaying the
+result to the user: Many prettifications are applied to the
+result returned.  If you want to decode an address for further
+non-display use, you should probably use
+`mail-header-parse-address' instead."
   (let ((canonicalization-buffer (get-buffer-create " *canonical address*"))
        (extraction-buffer (get-buffer-create " *extract address components*"))
        value-list)