From cbbb8d229f2b34f944493ea3415c18a80b776359 Mon Sep 17 00:00:00 2001 From: Nick Helm Date: Sun, 18 Mar 2018 21:05:44 +1300 Subject: [PATCH 2/2] Improve `with-help-window' docstring. * lisp/help.el (with-help-window): Rewrite docstring, adding reference to `help-window-setup'. --- lisp/help.el | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/lisp/help.el b/lisp/help.el index 55abecc05d..958b06c095 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -1371,14 +1371,13 @@ 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-or-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." + "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 -- 2.14.3 (Apple Git-98)