Mercurial > emacs
changeset 75839:e71b1d9b5c5e
(with-electric-help, electric-help-exit, electric-help-retain): Doc fixes.
| author | Juanma Barranquero <lekktu@gmail.com> |
|---|---|
| date | Tue, 13 Feb 2007 12:47:00 +0000 |
| parents | 404cd4b4fb09 |
| children | d8cb8b355d6d |
| files | lisp/ehelp.el |
| diffstat | 1 files changed, 4 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ehelp.el Tue Feb 13 12:25:18 2007 +0000 +++ b/lisp/ehelp.el Tue Feb 13 12:47:00 2007 +0000 @@ -113,7 +113,6 @@ ;;;###autoload (defun with-electric-help (thunk &optional buffer noerase minheight) "Pop up an \"electric\" help buffer. -The arguments are THUNK &optional BUFFER NOERASE MINHEIGHT. THUNK is a function of no arguments which is called to initialize the contents of BUFFER. BUFFER defaults to `*Help*'. BUFFER will be erased before THUNK is called unless NOERASE is non-nil. THUNK will @@ -125,7 +124,7 @@ 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 -in electric-help-mode. The window's height will be at least MINHEIGHT if +in `electric-help-mode'. The window's height will be at least MINHEIGHT if this value is non-nil. If THUNK returns nil, we display BUFFER starting at the top, and @@ -134,7 +133,7 @@ When the user exits (with `electric-help-exit', or otherwise), the help buffer's window disappears (i.e., we use `save-window-excursion'), and -BUFFER is put into `default-major-mode' (or `fundamental-mode') when we exit." +BUFFER is put into `default-major-mode' (or `fundamental-mode')." (setq buffer (get-buffer-create (or buffer "*Help*"))) (let ((one (one-window-p t)) (config (current-window-configuration)) @@ -246,7 +245,7 @@ ; (scroll-up arg))) (defun electric-help-exit () - "Exit `electric-help', restoring the previous window/buffer configuration. + "Exit `with-electric-help', restoring the previous window/buffer configuration. \(The *Help* buffer will be buried.)" (interactive) ;; Make sure that we don't throw twice, even if two events cause @@ -257,7 +256,7 @@ (throw 'exit t)))) (defun electric-help-retain () - "Exit `electric-help', retaining the current window/buffer configuration. + "Exit `with-electric-help', retaining the current window/buffer configuration. \(The *Help* buffer will not be selected, but \\[switch-to-buffer-other-window] RET will select it.)" (interactive)