mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-27 07:37:33 +00:00
Code Issues Releases Activity

(with-electric-help): Doc fix.

Browse Source
This commit is contained in:
Richard M. Stallman 1995-07-30 07:04:58 +00:00
parent 639f52d858
commit bbe2ecf64b
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lisp/ehelp.el
View File

@ -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