From: Lars Ingebrigtsen Date: Sun, 15 Apr 2018 17:45:05 +0000 (+0200) Subject: mail-extr.el: Mention `mail-header-parse-address' in the doc string X-Git-Tag: emacs-27.0.90~5183 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=47d52c22559da40003dcd02ad32097562a8573d5;p=emacs.git 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. --- diff --git a/lisp/mail/mail-extr.el b/lisp/mail/mail-extr.el index 3e8a41fb24c..0175c687b26 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)