aboutsummaryrefslogtreecommitdiffstats
path: root/etc
diff options
context:
space:
mode:
authorJoão Távora2020-07-05 12:55:27 +0100
committerJoão Távora2020-07-08 11:25:33 +0100
commitbba3bea247675df234353f0c2cd8af7da23bc6b8 (patch)
treee03738dc3e3e0f753eadb6c5013e8e143a6dc638 /etc
parent1203626f472b0d99d2746f5999711137c0c1fd0c (diff)
downloademacs-bba3bea247675df234353f0c2cd8af7da23bc6b8.tar.gz
emacs-bba3bea247675df234353f0c2cd8af7da23bc6b8.zip
Adjust Eldoc documentation after Eli's review
* etc/NEWS (Eldoc): Adjust paragraphs. * lisp/emacs-lisp/eldoc.el (eldoc-prefer-doc-buffer): Adjust docstring. (eldoc--enthusiasm-curbing-timer, eldoc-documentation-strategy) (eldoc-documentation-functions): Adjust docstring. (eldoc--handle-docs): Adjust comments. (eldoc--documentation-compose-1): New helper. (eldoc-documentation-compose) (eldoc-documentation-compose-eagerly): Use it. (eldoc-print-current-symbol-info): Adjust comments.
Diffstat (limited to 'etc')
-rw-r--r--etc/NEWS20
1 files changed, 14 insertions, 6 deletions
diff --git a/etc/NEWS b/etc/NEWS
index f5b9e5ed152..125457c609b 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -247,17 +247,25 @@ supplied error message.
247+++ 247+++
248** ElDoc 248** ElDoc
249 249
250*** New hook 'eldoc-documentation-functions' to be used for registering 250*** New hook 'eldoc-documentation-functions' to be used for
251doc string functions. This makes the results of all doc string 251registering doc string functions. These functions don't need to
252functions accessible to the user through the existing single function hook 252produce the doc string right away, they may arrange for it to be
253'eldoc-documentation-function'. 253produced asynchronously. The results of all doc string functions
254accessible to the user through the existing single function hook
255'eldoc-documentation-strategy.
254 256
255*** New user option 'eldoc-documentation-strategy' 257*** New user option 'eldoc-documentation-strategy'
256The built-in choices available for this user option let users compose 258The built-in choices available for this user option let users compose
257the results of 'eldoc-documentation-functions' in various ways. The 259the results of 'eldoc-documentation-functions' in various ways, even
258user option replaces 'eldoc-documentation-function', which is now 260if some of those functions are sychronous and some asynchchronous.
261The user option replaces 'eldoc-documentation-function', which is now
259obsolete. 262obsolete.
260 263
264*** The user option 'eldoc-echo-area-use-multiline-p' is now handled
265by the Eldoc library itself. Functions in
266'eldoc-documentation-functions' don't need to worry about consulting
267it when producing a doc string.
268
261** Eshell 269** Eshell
262 270
263--- 271---