[Emacs-diffs] emacs/lisp/mail mail-utils.el

[Glenn Morris]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Glenn Morris <gm>       09/01/31 02:52:18

Modified files:
        lisp/mail      : mail-utils.el 

Log message:
        (mail-fetch-field): Doc fix.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/emacs/lisp/mail/mail-utils.el?cvsroot=emacs&r1=1.68&r2=1.69

Patches:
Index: mail-utils.el
===================================================================
RCS file: /sources/emacs/emacs/lisp/mail/mail-utils.el,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -b -r1.68 -r1.69
--- mail-utils.el       10 Jan 2009 23:18:08 -0000      1.68
+++ mail-utils.el       31 Jan 2009 02:52:18 -0000      1.69
@@ -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)