mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Adjust describe-char-eldoc to new eldoc-documentation-functions protocol

Browse source 
* lisp/descr-text.el (describe-char-eldoc): Adjust to new
eldoc-documentation-functions protocol.
This commit is contained in:
João Távora 2020-07-07 13:35:07 +01:00
parent bba3bea247
commit b3efd5c228
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lisp/descr-text.el
View file

@ -919,7 +919,7 @@ condition, the function may return string longer than WIDTH, see
(t name)))))))
;;;###autoload
(defun describe-char-eldoc ()
(defun describe-char-eldoc (_callback &rest _)
"Return a description of character at point for use by ElDoc mode.
Return nil if character at point is a printable ASCII
@ -934,7 +934,12 @@ This function can be used as a value of
(let ((ch (following-char)))
(when (and (not (zerop ch)) (or (< ch 32) (> ch 127)))
;; TODO: investigate if the new `eldoc-documentation-functions'
;; API could significantly improve this.
;; API could significantly improve this. JT@2020-07-07: Indeed,
;; 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
;; to its space contraints.
(describe-char-eldoc--format
ch
(unless (eq eldoc-echo-area-use-multiline-p t)