summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2018-04-15 19:45:05 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2018-04-15 19:45:05 +0200
commit47d52c22559da40003dcd02ad32097562a8573d5 (patch)
tree2e2cdefe9c1c131dec26d885d897e3c7ba02e097
parenta38f79a8fd9c48b8911cad34159a64e97811a0ee (diff)
downloademacs-47d52c22559da40003dcd02ad32097562a8573d5.tar.gz
emacs-47d52c22559da40003dcd02ad32097562a8573d5.tar.bz2
emacs-47d52c22559da40003dcd02ad32097562a8573d5.zip
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.
-rw-r--r--lisp/mail/mail-extr.el8
1 files changed, 7 insertions, 1 deletions
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)