aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoão Távora2020-07-07 13:35:07 +0100
committerJoão Távora2020-07-08 11:25:33 +0100
commitb3efd5c22886743da3ea4b3abea6ca880db3d594 (patch)
tree5795b8ac4d6aba0a4ddfed7c5af07d008e52c0fe
parentbba3bea247675df234353f0c2cd8af7da23bc6b8 (diff)
downloademacs-b3efd5c22886743da3ea4b3abea6ca880db3d594.tar.gz
emacs-b3efd5c22886743da3ea4b3abea6ca880db3d594.zip
Adjust describe-char-eldoc to new eldoc-documentation-functions protocol
* lisp/descr-text.el (describe-char-eldoc): Adjust to new eldoc-documentation-functions protocol.
-rw-r--r--lisp/descr-text.el9
1 files changed, 7 insertions, 2 deletions
diff --git a/lisp/descr-text.el b/lisp/descr-text.el
index 22cfccb1fb2..776ce7618d5 100644
--- a/lisp/descr-text.el
+++ b/lisp/descr-text.el
@@ -919,7 +919,7 @@ condition, the function may return string longer than WIDTH, see
919 (t name))))))) 919 (t name)))))))
920 920
921;;;###autoload 921;;;###autoload
922(defun describe-char-eldoc () 922(defun describe-char-eldoc (_callback &rest _)
923 "Return a description of character at point for use by ElDoc mode. 923 "Return a description of character at point for use by ElDoc mode.
924 924
925Return nil if character at point is a printable ASCII 925Return nil if character at point is a printable ASCII
@@ -934,7 +934,12 @@ This function can be used as a value of
934 (let ((ch (following-char))) 934 (let ((ch (following-char)))
935 (when (and (not (zerop ch)) (or (< ch 32) (> ch 127))) 935 (when (and (not (zerop ch)) (or (< ch 32) (> ch 127)))
936 ;; TODO: investigate if the new `eldoc-documentation-functions' 936 ;; TODO: investigate if the new `eldoc-documentation-functions'
937 ;; API could significantly improve this. 937 ;; API could significantly improve this. JT@2020-07-07: Indeed,
938 ;; instead of returning a string tailored here for the echo area
939 ;; exclusively, we could call the (now unused) argument
940 ;; _CALLBACK with hints on how to shorten the string if needed,
941 ;; or with multiple usable strings which Eldoc picks according
942 ;; to its space contraints.
938 (describe-char-eldoc--format 943 (describe-char-eldoc--format
939 ch 944 ch
940 (unless (eq eldoc-echo-area-use-multiline-p t) 945 (unless (eq eldoc-echo-area-use-multiline-p t)