changeset 86438:194e0eca9ec2

(Help Functions): Clean up last change.
author Richard M. Stallman <rms@gnu.org>
date Sun, 25 Nov 2007 03:51:07 +0000
parents 5e5bea44b40c
children 62ce066ba56f
files doc/lispref/help.texi
diffstat 1 files changed, 9 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/help.texi	Sun Nov 25 03:50:39 2007 +0000
+++ b/doc/lispref/help.texi	Sun Nov 25 03:51:07 2007 +0000
@@ -688,14 +688,15 @@
 @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