Commit a07c9a8b authored by Richard M. Stallman's avatar Richard M. Stallman
Browse files

(Help Functions): Clean up last change.

parent b1baed0b
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> 2007-11-24 Richard Stallman <rms@gnu.org>
* functions.texi (Declaring Functions): Clarify previous change. * functions.texi (Declaring Functions): Clarify previous change.
......
...@@ -688,14 +688,15 @@ binding of @kbd{C-h C-h}. ...@@ -688,14 +688,15 @@ binding of @kbd{C-h C-h}.
@end defmac @end defmac
@defmac with-help-window buffer-name body@dots{} @defmac with-help-window buffer-name body@dots{}
This macro evaluates the @var{body} forms inserting any output they This macro evaluates the @var{body} forms, inserting any output they
produce into a buffer named @var{buffer-name}. @code{with-help-window} produce into a buffer named @var{buffer-name} like
behaves like @code{with-output-to-temp-buffer} (@pxref{Temporary @code{with-output-to-temp-buffer} (@pxref{Temporary Displays}). It
Displays}) but does more accurately restore the previous window also puts that buffer in Help mode, displays a message telling the
configuration when quitting Help. It also generates the message user how to quit and scroll the help window, and does various other
informing the user how to quit and scroll the help window by itself. things that make a help window work better.
Hence you will regret it if you use @code{print-help-return-message} in
the body of this macro. Don't use @code{print-help-return-message} in the body of this macro;
it would cause bad results.
@end defmac @end defmac
@defopt three-step-help @defopt three-step-help
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment