Function: with-help-window

with-help-window is a macro defined in help.el.gz.

Signature

(with-help-window BUFFER-OR-NAME &rest BODY)

Documentation

Evaluate BODY, send output to BUFFER-OR-NAME and show in a help window.

The return value from BODY will be returned.

The help window will be selected if help-window-select is non-nil.

The temp-buffer-window-setup-hook hook is called.

View in manual

Probably introduced at or before Emacs version 23.1.

Source Code

;; Defined in /usr/src/emacs/lisp/help.el.gz
(defmacro with-help-window (buffer-or-name &rest body)
  "Evaluate BODY, send output to BUFFER-OR-NAME and show in a help window.
The return value from BODY will be returned.

The help window will be selected if `help-window-select' is
non-nil.

The `temp-buffer-window-setup-hook' hook is called."
  (declare (indent 1) (debug t))
  `(help--window-setup ,buffer-or-name (lambda () ,@body)))