From: Basil L. Contovounesios Date: Tue, 14 Jul 2020 12:49:34 +0000 (+0100) Subject: Consistently stylize eldoc as ElDoc in more prose X-Git-Tag: emacs-28.0.90~7009 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=36e6019034ab5af18f634644187c75863ef6ca80;p=emacs.git Consistently stylize eldoc as ElDoc in more prose This fixes new occurrences of "Eldoc" since emacs-27. * doc/lispref/modes.texi (Major Mode Conventions): * etc/NEWS: * lisp/descr-text.el (describe-char-eldoc): * lisp/emacs-lisp/eldoc.el (eldoc-echo-area-use-multiline-p) (eldoc-prefer-doc-buffer, eldoc--documentation-strategy-defcustom): Consistently capitalize eldoc as ElDoc rather than Eldoc in documentation and commentary. --- diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 17e96079ab9..33a07c9fb4d 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -469,7 +469,7 @@ variable @code{imenu-generic-expression}, for the two variables @code{imenu-create-index-function} (@pxref{Imenu}). @item -The mode can tell Eldoc mode how to retrieve different types of +The mode can tell ElDoc mode how to retrieve different types of documentation for whatever is at point, by adding one or more buffer-local entries to the special hook @code{eldoc-documentation-functions}. diff --git a/etc/NEWS b/etc/NEWS index e55f57e01af..2afd4dee34f 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -263,7 +263,7 @@ obsolete. *** 'eldoc-echo-area-use-multiline-p' is now handled by ElDoc. The user option 'eldoc-echo-area-use-multiline-p' is now handled -by the Eldoc library itself. Functions in +by the ElDoc library itself. Functions in 'eldoc-documentation-functions' don't need to worry about consulting it when producing a doc string. diff --git a/lisp/descr-text.el b/lisp/descr-text.el index 6246f59d495..5cbdf444cf9 100644 --- a/lisp/descr-text.el +++ b/lisp/descr-text.el @@ -950,7 +950,7 @@ This function can be used as a value of ;; instead of returning a string tailored here for the echo area ;; exclusively, we could call the (now unused) argument ;; _CALLBACK with hints on how to shorten the string if needed, - ;; or with multiple usable strings which Eldoc picks according + ;; or with multiple usable strings which ElDoc picks according ;; to its space contraints. (describe-char-eldoc--format ch diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index 1dd0ea2942d..1a009bdefac 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -92,7 +92,7 @@ echo area must be resized to fit. If value is a number (integer or floating point), it has the semantics of `max-mini-window-height', constraining the resizing -for Eldoc purposes only. +for ElDoc purposes only. Any resizing respects `max-mini-window-height'. @@ -112,9 +112,9 @@ single line of display in the echo area." line" truncate-sym-name-if-fit))) (defcustom eldoc-prefer-doc-buffer nil - "Prefer Eldoc's documentation buffer if it is showing in some frame. + "Prefer ElDoc's documentation buffer if it is showing in some frame. If this variable's value is t and a piece of documentation needs -to be truncated to fit in the echo area, do so if Eldoc's +to be truncated to fit in the echo area, do so if ElDoc's documentation buffer is not already showing, since the buffer always holds the full documentation." :type 'boolean) @@ -539,11 +539,11 @@ Meant as a value for `eldoc-documentation-strategy'." (if (stringp str) (funcall callback str)) nil)))) -;; JT@2020-07-10: Eldoc is pre-loaded, so in in Emacs < 28 we can't +;; JT@2020-07-10: ElDoc is pre-loaded, so in Emacs < 28 we can't ;; make the "old" `eldoc-documentation-function' point to the new ;; `eldoc-documentation-strategy', so we do the reverse. This allows -;; for Eldoc to be loaded in those older Emacs versions and work with -;; whomever (major-modes, extensions, ueser) sets one of the other +;; for ElDoc to be loaded in those older Emacs versions and work with +;; whomever (major-modes, extensions, user) sets one or the other ;; variable. (defmacro eldoc--documentation-strategy-defcustom (main secondary value docstring &rest more)