emacs/gnu.emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2026-09-10 15:56:35 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve eldoc-help-at-pt docstrings

Browse source 
* lisp/emacs-lisp/eldoc.el (eldoc-help-at-pt, eldoc-show-help-at-pt):
Improve docstrings.  (Bug#81356)
This commit is contained in:
Daniel Mendler 2026-07-09 17:20:44 +02:00 committed by Eli Zaretskii
parent f9a8c61f50
commit 8e5c0386f1
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lisp/emacs-lisp/eldoc.el
View file

@ -140,9 +140,9 @@ is only skipped if the documentation needs to be truncated there."
(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'. If
the value is non-nil, `eldoc-show-help-at-pt' will show help-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)
@ -980,8 +980,10 @@ the docstrings eventually produced, using
(eldoc--invoke-strategy nil))))))
(defun eldoc-show-help-at-pt (&rest _)
"Show help at point via Eldoc if `eldoc-help-at-pt' is non-nil.
Intended for `eldoc-documentation-functions' (which see)."
"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))))