Doc-fix.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 5dd15efef8214fd408a252d0209996d7a8ad74fe..5be3acda0135e2a76fc6ed85df9202d6ae388781 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -13,6 +13,8 @@
        * comint.el (comint-output-filter): Make the Comint buffer current
        for the comint-preoutput-filter-functions.
 
+       * mail/reporter.el: Doc fix.
+
 1999-10-24  Stephen Eglen  <stephen@gnu.org>
 
        * progmodes/octave-mod.el (octave-auto-indent): Remove :version so

diff --git a/lisp/mail/reporter.el b/lisp/mail/reporter.el
index f276e56b0fb2982b392da16b84fb4d78c25d6d63..cd9ff426c6b936344f1c5fef6ea95cd1daa96b45 100644 (file)
--- a/lisp/mail/reporter.el
+++ b/lisp/mail/reporter.el
@@ -311,19 +311,25 @@ composed.")
 ;;;###autoload
 (defun reporter-submit-bug-report
   (address pkgname varlist &optional pre-hooks post-hooks salutation)
-  ;; Submit a bug report via mail.
+"Begin submitting a bug report via email.
 
-  ;; ADDRESS is the email address for the package's maintainer. PKGNAME is
-  ;; the name of the mode (you must explicitly concat any version numbers).
-  ;; VARLIST is the list of variables to dump (see `reporter-dump-state'
-  ;; for details). Optional PRE-HOOKS and POST-HOOKS are passed to
-  ;; `reporter-dump-state'. Optional SALUTATION is inserted at the top of the
-  ;; mail buffer, and point is left after the salutation.
+ADDRESS is the email address for the package's maintainer.  PKGNAME is
+the name of the package (if you want to include version numbers,
+you must put them into PKGNAME before calling this function).
 
-  ;; This function will prompt for a summary if
-  ;; reporter-prompt-for-summary-p is non-nil.
+VARLIST is the list of variables to dump (see `reporter-dump-state'
+for details).  The optional argument PRE-HOOKS and POST-HOOKS are
+passed to `reporter-dump-state'.  Optional argument SALUTATION is text
+to be inserted at the top of the mail buffer; in that case, point is
+left after that text.
 
-  ;; The mailer used is described in by the variable `mail-user-agent'.
+This function prompts for a summary if `reporter-prompt-for-summary-p'
+is non-nil.
+
+This function does not send a message; it uses the given information
+to initialize a a messagem, which the user can then edit and finally send
+(or decline to send).  The variable `mail-user-agent' controls which
+mail-sending package is used for editing and sending the message."
   (let ((reporter-eval-buffer (current-buffer))
        final-resting-place
        after-sep-pos