]> code.delx.au - gnu-emacs/commitdiff
(Help Functions): Clean up last change.
authorRichard M. Stallman <rms@gnu.org>
Sun, 25 Nov 2007 03:51:14 +0000 (03:51 +0000)
committerRichard M. Stallman <rms@gnu.org>
Sun, 25 Nov 2007 03:51:14 +0000 (03:51 +0000)
doc/lispref/ChangeLog
doc/lispref/help.texi

index 05245e8126aafe60a4540c236123a7ec53912cd8..928753ff1facbcb7442ada68eaf57fbe4d241f9c 100644 (file)
@@ -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.
index c23d6808488994b9194724aeb8a9444ae7de4ab9..1454e5ab95e601421b2be8cea15ab7f0095de3da 100644 (file)
@@ -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