[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 87f025117b8 08/10: ; Eldoc: fix doc of e-d-functions w.r.t. :orig
From: |
João Távora |
Subject: |
master 87f025117b8 08/10: ; Eldoc: fix doc of e-d-functions w.r.t. :origin keyword |
Date: |
Sun, 2 Apr 2023 19:15:40 -0400 (EDT) |
branch: master
commit 87f025117b8bafc0780a6ef4a6308dfdc2be0859
Author: João Távora <joaotavora@gmail.com>
Commit: João Távora <joaotavora@gmail.com>
; 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)
- master updated (093a360251a -> f886ae5cf07), João Távora, 2023/04/02
- master d00e05daa96 04/10: Eglot: take advantage of new Eldoc options for signature doc, João Távora, 2023/04/02
- master a8c1559a663 01/10: Eglot: remove hacky advice of jsonrpc-request, João Távora, 2023/04/02
- master ad1efe5e675 05/10: Eglot: improve caching in eglot-completion-at-point, João Távora, 2023/04/02
- master 66c48f9e46a 02/10: Eglot: define eglot--ensure-list with defalias, João Távora, 2023/04/02
- master 87f025117b8 08/10: ; Eldoc: fix doc of e-d-functions w.r.t. :origin keyword,
João Távora <=
- master f886ae5cf07 10/10: ; * etc/EGLOT-NEWS (Upcoming 1.14): Update., João Távora, 2023/04/02
- master bdb400912e0 06/10: Eglot: load built-in GNU ELPA dependencies explicitly, João Távora, 2023/04/02
- master f2357df91f0 09/10: Eldoc: bump package version to 1.14.0, João Távora, 2023/04/02
- master ecf53a50037 07/10: ; Eglot: removed unused dependency on 'array.el', João Távora, 2023/04/02
- master d69d0b1a296 03/10: Eglot: declare support for markdown also for signatures, João Távora, 2023/04/02