branch: externals/embark
commit 7a44a20bd7f40573e0adbfb76c96d43ff0a980d7
Author: Daniel Mendler <[email protected]>
Commit: Daniel Mendler <[email protected]>
README: Don't set the Eldoc documentation strategy, add comment.
---
README.org | 5 +++--
embark.texi | 5 +++--
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 45ebc33a16..cfc51ee2f4 100644
--- a/README.org
+++ b/README.org
@@ -306,9 +306,10 @@ starting configuration:
;; Optionally replace the key help with a completing-read interface
(setq prefix-help-command #'embark-prefix-help-command)
- ;; Show the Embark target at point via Eldoc
- (setq eldoc-documentation-strategy #'eldoc-documentation-compose-eagerly)
+ ;; Show the Embark target at point via Eldoc. You may adjust the Eldoc
+ ;; strategy, if you want to see the documentation from multiple providers.
(add-hook 'eldoc-documentation-functions #'embark-eldoc-first-target)
+ ;; (setq eldoc-documentation-strategy
#'eldoc-documentation-compose-eagerly)
:config
diff --git a/embark.texi b/embark.texi
index 7059115819..f8e50431ab 100644
--- a/embark.texi
+++ b/embark.texi
@@ -417,9 +417,10 @@ starting configuration:
;; Optionally replace the key help with a completing-read interface
(setq prefix-help-command #'embark-prefix-help-command)
- ;; Show the Embark target at point via Eldoc
- (setq eldoc-documentation-strategy #'eldoc-documentation-compose-eagerly)
+ ;; Show the Embark target at point via Eldoc. You may adjust the Eldoc
+ ;; strategy, if you want to see the documentation from multiple providers.
(add-hook 'eldoc-documentation-functions #'embark-eldoc-first-target)
+ ;; (setq eldoc-documentation-strategy #'eldoc-documentation-compose-eagerly)
:config