From: Richard M. Stallman <rms@gnu.org>
Date: Sun, 30 Jul 1995 07:04:58 +0000 (+0000)
Subject: (with-electric-help): Doc fix.
X-Git-Tag: emacs-19.34~3139
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=bbe2ecf64b3c3540a66c5bee81ad4a20c93fd6ff;p=emacs.git

(with-electric-help): Doc fix.
---

diff --git a/lisp/ehelp.el b/lisp/ehelp.el
index fb2cd370239..fda84b7a357 100644
--- a/lisp/ehelp.el
+++ b/lisp/ehelp.el
@@ -29,6 +29,12 @@
 ;; function that generates the actual text of the help into the current
 ;; buffer.
 
+;; To make this the default, you must do
+;; (require 'ehelp)
+;; (define-key global-map "\C-h" 'ehelp-command)
+;; (define-key global-map [help] 'ehelp-command)
+;; (define-key global-map [f1] 'ehelp-command)
+
 ;;; Code:
 
 (require 'electric)
@@ -71,11 +77,15 @@
 
 ;;;###autoload
 (defun with-electric-help (thunk &optional buffer noerase)
-  "Arguments are THUNK &optional BUFFER NOERASE.  BUFFER defaults to `*Help*'.
+  "Pop up an \"electric\" help buffer.
+Arguments are THUNK &optional BUFFER NOERASE.  BUFFER defaults to `*Help*'.
 THUNK is a function of no arguments which is called to initialize
 the contents of BUFFER.  BUFFER will be erased before THUNK is called unless
 NOERASE is non-nil.  THUNK will be called with `standard-output' bound to
-the buffer specified by BUFFER
+the buffer specified by BUFFER.
+
+If THUNK returns nil, we display BUFFER starting at the top, and
+shrink the window to fit.  If THUNK returns non-nil, we don't do those things.
 
 After THUNK has been called, this function \"electrically\" pops up a window
 in which BUFFER is displayed and allows the user to scroll through that buffer
@@ -323,8 +333,6 @@ will select it.)"
     (setq ehelp-map map)
     (fset 'ehelp-command map)))
 
-;; Do (define-key global-map "\C-h" 'ehelp-command) if you want to win
-
 (provide 'ehelp) 
 
 ;;; ehelp.el ends here