From 87f025117b8bafc0780a6ef4a6308dfdc2be0859 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jo=C3=A3o=20T=C3=A1vora?= Date: Sun, 2 Apr 2023 23:38:37 +0100 Subject: [PATCH] ; Eldoc: fix doc of e-d-functions w.r.t. :origin keyword * lisp/emacs-lisp/eldoc.el (eldoc-documentation-functions): Fix. --- lisp/emacs-lisp/eldoc.el | 10 +++++----- 1 file 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: `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) -- 2.39.2