branch: externals/embark
commit b9f2b3b9a5b9c72cf1416097b9941c4f275dae94
Author: Omar Antolín <[email protected]>
Commit: Omar Antolín <[email protected]>
Comment out eldoc configuration, since it is intrusive
---
README.org | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index a010932c15..a8a3d38ce5 100644
--- a/README.org
+++ b/README.org
@@ -366,9 +366,13 @@ 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. 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)
+ ;; Show the Embark target at point via Eldoc. You may adjust the
+ ;; Eldoc strategy, if you want to see the documentation from
+ ;; multiple providers. Beware that using this can be a little
+ ;; jarring since the message shown in the minibuffer can be more
+ ;; than one line, causing the modeline to move up and down:
+
+ ;; (add-hook 'eldoc-documentation-functions #'embark-eldoc-first-target)
;; (setq eldoc-documentation-strategy
#'eldoc-documentation-compose-eagerly)
:config
