diff lisp/help.el @ 863:42375619fa45

[xemacs-hg @ 2002-06-04 06:03:59 by andyp] merge 21.4 windows changes, minimally tested
author andyp
date Tue, 04 Jun 2002 06:05:53 +0000
parents e38acbeb1cae
children 4bc5bb3ea5ad
line wrap: on
line diff
--- a/lisp/help.el	Mon Jun 03 12:24:14 2002 +0000
+++ b/lisp/help.el	Tue Jun 04 06:05:53 2002 +0000
@@ -487,11 +487,7 @@
 	(format "*%s*" name))
     (format "*%s*" help-buffer-prefix-string)))
 
-;; Use this function for displaying help when C-h something is pressed
-;; or in similar situations.  Do *not* use it when you are displaying
-;; a help message and then prompting for input in the minibuffer --
-;; this macro usually selects the help buffer, which is not what you
-;; want in those situations.
+;; with-displaying-help-buffer
 
 ;; #### Should really be a macro to eliminate the requirement of
 ;; caller to code a lambda form in THUNK -- mrb
@@ -518,7 +514,13 @@
 
 (defun with-displaying-help-buffer (thunk &optional name)
   "Form which makes a help buffer with given NAME and evaluates BODY there.
-The actual name of the buffer is generated by the function `help-buffer-name'."
+The actual name of the buffer is generated by the function `help-buffer-name'.
+
+Use this function for displaying help when C-h something is pressed or
+in similar situations.  Do *not* use it when you are displaying a help
+message and then prompting for input in the minibuffer -- this macro
+usually selects the help buffer, which is not what you want in those
+situations."
   (let* ((winconfig (current-window-configuration))
 	 (was-one-window (one-window-p))
 	 (buffer-name (help-buffer-name name))