Variable: eldoc-help-at-pt

eldoc-help-at-pt is a customizable variable defined in eldoc.el.gz.

Value

nil

Documentation

If non-nil, show help-at-pt-kbd-string at point via Eldoc.

This setting is an alternative to help-at-pt-display-when-idle. In order to enable help at point only in certain buffers add eldoc-show-help-at-pt locally to eldoc-documentation-functions.

This variable was added, or its default value changed, in Emacs 31.1.

View in manual

Probably introduced at or before Emacs version 31.1.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/eldoc.el.gz
(defcustom eldoc-help-at-pt nil
  "If non-nil, show `help-at-pt-kbd-string' at point via Eldoc.
This setting is an alternative to `help-at-pt-display-when-idle'.  In
order to enable help at point only in certain buffers add
`eldoc-show-help-at-pt' locally to `eldoc-documentation-functions'."
  :type 'boolean
  :set (lambda (sym val)
         (custom-set-default sym val)
         (if val
             (add-hook 'eldoc-documentation-functions #'eldoc-show-help-at-pt 90)
           (remove-hook 'eldoc-documentation-functions #'eldoc-show-help-at-pt)))
  :version "31.1")