Function: eldoc-show-help-at-pt

eldoc-show-help-at-pt is a byte-compiled function defined in eldoc.el.gz.

Signature

(eldoc-show-help-at-pt &rest _)

Documentation

Show help at point via Eldoc taken from help-at-pt-kbd-string.

This function is intended to be added buffer-locally by major modes to eldoc-documentation-functions. In order to enable help at point globally, users can set eldoc-help-at-pt to t.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/eldoc.el.gz
(defun eldoc-show-help-at-pt (&rest _)
  "Show help at point via Eldoc taken from `help-at-pt-kbd-string'.
This function is intended to be added buffer-locally by major modes to
`eldoc-documentation-functions'.  In order to enable help at point
globally, users can set `eldoc-help-at-pt' to t."
  (when-let* ((help (help-at-pt-kbd-string)))
    (format "Help: %s" (substitute-command-keys help))))