diff options
| author | Nick Helm <nick@tenpoint.co.nz> | 2018-03-18 21:05:44 +1300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2018-03-20 14:19:14 +0200 |
| commit | 2fb52abd9e74f722c08c5e59f63dee8821789e1a (patch) | |
| tree | a7d20dff222e9077f40ac7b7587abb192bd3649c /lisp/help.el | |
| parent | ec08c62f036c3c86f1e00d54a47c405299a19993 (diff) | |
| download | emacs-2fb52abd9e74f722c08c5e59f63dee8821789e1a.tar.gz | |
Improve documentation of 'with-help-window'
* doc/lispref/help.texi (Help Functions): Change variable name
to 'buffer-or-name'.
* lisp/help.el (with-help-window): Change variable name to
'buffer-or-name' and rewrite the doc string, adding reference
to 'help-window-setup'. (Bug#30792)
Diffstat (limited to 'lisp/help.el')
| -rw-r--r-- | lisp/help.el | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/lisp/help.el b/lisp/help.el index 014af5141e3..958b06c0958 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -1370,15 +1370,14 @@ Return VALUE." ;; (4) A marker (`help-window-point-marker') to move point in the help ;; window to an arbitrary buffer position. -(defmacro with-help-window (buffer-name &rest body) - "Display buffer named BUFFER-NAME in a help window. -Evaluate the forms in BODY with standard output bound to a buffer -called BUFFER-NAME (creating it if it does not exist), put that -buffer in `help-mode', display the buffer in a window (see -`with-temp-buffer-window' for details) and issue a message how to -deal with that \"help\" window when it's no more needed. Select -the help window if the current value of the user option -`help-window-select' says so. Return last value in BODY." +(defmacro with-help-window (buffer-or-name &rest body) + "Evaluate BODY, send output to BUFFER-OR-NAME and show in a help window. +This construct is like `with-temp-buffer-window' but unlike that +puts the buffer specified by BUFFER-OR-NAME in `help-mode' and +displays a message about how to delete the help window when it's no +longer needed. The help window will be selected if +`help-window-select' is non-nil. See `help-window-setup' for +more options." (declare (indent 1) (debug t)) `(progn ;; Make `help-window-point-marker' point nowhere. The only place @@ -1390,7 +1389,7 @@ the help window if the current value of the user option (cons 'help-mode-finish temp-buffer-window-show-hook))) (setq help-window-old-frame (selected-frame)) (with-temp-buffer-window - ,buffer-name nil 'help-window-setup (progn ,@body))))) + ,buffer-or-name nil 'help-window-setup (progn ,@body))))) ;; Called from C, on encountering `help-char' when reading a char. ;; Don't print to *Help*; that would clobber Help history. |