Function: help-window-display-message

help-window-display-message is a byte-compiled function defined in help.el.gz.

Signature

(help-window-display-message QUIT-PART WINDOW &optional SCROLL)

Documentation

Display message telling how to quit and scroll help window.

QUIT-PART is a string telling how to quit the help window WINDOW. Optional argument SCROLL non-nil means tell how to scroll WINDOW. SCROLL equal other means tell how to scroll the "other" window.

Source Code

;; Defined in /usr/src/emacs/lisp/help.el.gz
(defun help-window-display-message (quit-part window &optional scroll)
  "Display message telling how to quit and scroll help window.
QUIT-PART is a string telling how to quit the help window WINDOW.
Optional argument SCROLL non-nil means tell how to scroll WINDOW.
SCROLL equal `other' means tell how to scroll the \"other\"
window."
  (let ((scroll-part
	 (cond
	  ;; If we don't have QUIT-PART we probably reuse a window
	  ;; showing the same buffer so we don't show any message.
	  ((not quit-part) nil)
	  ((pos-visible-in-window-p
	    (with-current-buffer (window-buffer window)
	      (point-max)) window t)
	   ;; Buffer end is at least partially visible, no need to talk
	   ;; about scrolling.
	   ".")
	  ((eq scroll 'other)
	   ", \\[scroll-other-window] to scroll help.")
          (scroll ", \\[scroll-up-command] to scroll help."))))
    (message "%s"
     (substitute-command-keys (concat quit-part scroll-part)))))