Github/emacs
2
0
Fork 1
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-16 17:24:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

; Eldoc: fix doc of e-d-functions w.r.t. :origin keyword

Browse source 
* lisp/emacs-lisp/eldoc.el (eldoc-documentation-functions): Fix.
This commit is contained in:
João Távora 2023-04-02 23:38:37 +01:00
parent ecf53a5003
commit 87f025117b
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -448,17 +448,17 @@ documentation-displaying frontends. For example, KEY can be:
`eldoc-display-in-echo-area' and `eldoc-display-in-buffer' will
use when displaying `:thing''s value.
* `:origin', VALUE being the member of
`eldoc-documentation-functions' where DOCSTRING
originated. `eldoc-display-in-buffer' may use this organize the
documentation buffer accordingly.
* `:echo', controlling how `eldoc-display-in-echo-area' should
present this documentation item in the echo area, to save
space. If VALUE is a string, echo it instead of DOCSTRING. If
a number, only echo DOCSTRING up to that character position.
If `skip', don't echo DOCSTRING at all.
The additional KEY `:origin' is always added by ElDoc, its VALUE
being the member of `eldoc-documentation-functions' where
DOCSTRING originated. `eldoc-display-functions' may use this
information to organize display of multiple docstrings.
Finally, major modes should modify this hook locally, for
example:
(add-hook \\='eldoc-documentation-functions #\\='foo-mode-eldoc nil t)