aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoão Távora2023-04-02 23:38:37 +0100
committerJoão Távora2023-04-02 23:40:46 +0100
commit87f025117b8bafc0780a6ef4a6308dfdc2be0859 (patch)
treee319b1cd61fab2fcbaf4f910513b03579bfa1bc6
parentecf53a50037e66d0f1775c7046d54e218ddd26af (diff)
downloademacs-87f025117b8bafc0780a6ef4a6308dfdc2be0859.tar.gz
emacs-87f025117b8bafc0780a6ef4a6308dfdc2be0859.zip
; Eldoc: fix doc of e-d-functions w.r.t. :origin keyword
* lisp/emacs-lisp/eldoc.el (eldoc-documentation-functions): Fix.
-rw-r--r--lisp/emacs-lisp/eldoc.el10
1 files changed, 5 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el
index ef4cda4650f..8b427d6a825 100644
--- a/lisp/emacs-lisp/eldoc.el
+++ b/lisp/emacs-lisp/eldoc.el
@@ -448,17 +448,17 @@ documentation-displaying frontends. For example, KEY can be:
448 `eldoc-display-in-echo-area' and `eldoc-display-in-buffer' will 448 `eldoc-display-in-echo-area' and `eldoc-display-in-buffer' will
449 use when displaying `:thing''s value. 449 use when displaying `:thing''s value.
450 450
451* `:origin', VALUE being the member of
452 `eldoc-documentation-functions' where DOCSTRING
453 originated. `eldoc-display-in-buffer' may use this organize the
454 documentation buffer accordingly.
455
456* `:echo', controlling how `eldoc-display-in-echo-area' should 451* `:echo', controlling how `eldoc-display-in-echo-area' should
457 present this documentation item in the echo area, to save 452 present this documentation item in the echo area, to save
458 space. If VALUE is a string, echo it instead of DOCSTRING. If 453 space. If VALUE is a string, echo it instead of DOCSTRING. If
459 a number, only echo DOCSTRING up to that character position. 454 a number, only echo DOCSTRING up to that character position.
460 If `skip', don't echo DOCSTRING at all. 455 If `skip', don't echo DOCSTRING at all.
461 456
457The additional KEY `:origin' is always added by ElDoc, its VALUE
458being the member of `eldoc-documentation-functions' where
459DOCSTRING originated. `eldoc-display-functions' may use this
460information to organize display of multiple docstrings.
461
462Finally, major modes should modify this hook locally, for 462Finally, major modes should modify this hook locally, for
463example: 463example:
464 (add-hook \\='eldoc-documentation-functions #\\='foo-mode-eldoc nil t) 464 (add-hook \\='eldoc-documentation-functions #\\='foo-mode-eldoc nil t)