From: Richard M. Stallman <rms@gnu.org>
Date: Sun, 25 Nov 2007 03:51:14 +0000 (+0000)
Subject: (Help Functions): Clean up last change.
X-Git-Tag: emacs-pretest-23.0.90~9472
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a07c9a8b5bec6b3088d5f0580403e1d740648851;p=emacs.git

(Help Functions): Clean up last change.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 05245e8126a..928753ff1fa 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,15 @@
+2007-11-25  Richard Stallman  <rms@gnu.org>
+
+	* help.texi (Help Functions): Clean up last change.
+
+	* advice.texi (Preactivation, Activation of Advice): Minor cleanup.
+
+	* loading.texi (Named Features): Minor cleanup.
+
+	* macros.texi (Eval During Expansion): Minor cleanup.
+
+	* variables.texi (Variable Aliases): Minor cleanup.
+
 2007-11-24  Richard Stallman  <rms@gnu.org>
 
 	* functions.texi (Declaring Functions): Clarify previous change.
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index c23d6808488..1454e5ab95e 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -688,14 +688,15 @@ binding of @kbd{C-h C-h}.
 @end defmac
 
 @defmac with-help-window buffer-name body@dots{}
-This macro evaluates the @var{body} forms inserting any output they
-produce into a buffer named @var{buffer-name}.  @code{with-help-window}
-behaves like @code{with-output-to-temp-buffer} (@pxref{Temporary
-Displays}) but does more accurately restore the previous window
-configuration when quitting Help.  It also generates the message
-informing the user how to quit and scroll the help window by itself.
-Hence you will regret it if you use @code{print-help-return-message} in
-the body of this macro.
+This macro evaluates the @var{body} forms, inserting any output they
+produce into a buffer named @var{buffer-name} like
+@code{with-output-to-temp-buffer} (@pxref{Temporary Displays}).  It
+also puts that buffer in Help mode, displays a message telling the
+user how to quit and scroll the help window, and does various other
+things that make a help window work better.
+
+Don't use @code{print-help-return-message} in the body of this macro;
+it would cause bad results.
 @end defmac
 
 @defopt three-step-help