* lisp/simple.el (rfc822-goto-eoh): Give it a doc-string.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 6383427..98a9e06 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,7 @@
 2011-02-17  Glenn Morris  <rgm@gnu.org>
 
+       * simple.el (rfc822-goto-eoh): Give it a doc-string.
+
        * log-edit.el (log-edit-insert-changelog):
        Fix `log-edit-strip-single-file-name' functionality.  (Bug#8057)
 

diff --git a/lisp/simple.el b/lisp/simple.el
index 6e26e33..8f37c8e 100644 (file)
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -5585,7 +5585,10 @@ appears to have customizations applying to the old default,
   'mail-send-and-exit)
 
 (defun rfc822-goto-eoh ()
-  ;; Go to header delimiter line in a mail message, following RFC822 rules
+  "If the buffer starts with a mail header, move point to the header's end.
+Otherwise, moves to `point-min'.
+The end of the header is the start of the next line, if there is one,
+else the end of the last line.  This function obeys RFC822."
   (goto-char (point-min))
   (when (re-search-forward
         "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)