changeset 101696:923ce6cefb8e

(mail-fetch-field): Doc fix.
author Glenn Morris <rgm@gnu.org>
date Sat, 31 Jan 2009 02:52:18 +0000
parents 6241a2905cf0
children 7944a5c07ab1
files lisp/mail/mail-utils.el
diffstat 1 files changed, 5 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/mail/mail-utils.el	Sat Jan 31 02:51:18 2009 +0000
+++ b/lisp/mail/mail-utils.el	Sat Jan 31 02:52:18 2009 +0000
@@ -1,7 +1,7 @@
 ;;; mail-utils.el --- utility functions used both by rmail and rnews
 
-;; Copyright (C) 1985, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
+;;   2009  Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: mail, news
@@ -302,10 +302,11 @@
 ;;;###autoload
 (defun mail-fetch-field (field-name &optional last all list)
   "Return the value of the header field whose type is FIELD-NAME.
-The buffer is expected to be narrowed to just the header of the message.
 If second arg LAST is non-nil, use the last field of type FIELD-NAME.
 If third arg ALL is non-nil, concatenate all such fields with commas between.
-If 4th arg LIST is non-nil, return a list of all such fields."
+If 4th arg LIST is non-nil, return a list of all such fields.
+The header must be at the start of the buffer.  If any of the optional
+arguments are used, the buffer should be narrowed to just the header."
   (save-excursion
     (goto-char (point-min))
     (let ((case-fold-search t)