branch: externals/embark
commit 87295936028c96894728eb49ceaa0dd293372726
Author: Daniel Mendler <[email protected]>
Commit: Daniel Mendler <[email protected]>
embark-consult: Update commentary
---
embark-consult.el | 24 ++----------------------
1 file changed, 2 insertions(+), 22 deletions(-)
diff --git a/embark-consult.el b/embark-consult.el
index d26f019811..021a71ad00 100644
--- a/embark-consult.el
+++ b/embark-consult.el
@@ -27,9 +27,6 @@
;; This package provides integration between Embark and Consult. The package
;; will be loaded automatically by Embark.
-;; Some of the functionality here was previously contained in Embark
-;; itself:
-
;; - Support for consult-buffer, so that you get the correct actions
;; for each type of entry in consult-buffer's list.
@@ -39,24 +36,7 @@
;; you can export from them to an occur buffer (where occur-edit-mode
;; works!).
-;; Just load this package to get the above functionality, no further
-;; configuration is necessary.
-
-;; Additionally this package contains some functionality that has
-;; never been in Embark: access to Consult preview from auto-updating
-;; Embark Collect buffer that is associated to an active minibuffer
-;; for a Consult command. For information on Consult preview, see
-;; Consult's info manual or its readme on GitHub.
-
-;; If you always want the minor mode enabled whenever it possible use:
-
-;; (add-hook 'embark-collect-mode-hook #'consult-preview-at-point-mode)
-
-;; If you don't want the minor mode automatically on and prefer to
-;; trigger the consult previews manually use this instead:
-
-;; (keymap-set embark-collect-mode-map "C-j"
-;; #'consult-preview-at-point)
+;; - Enabling Consult preview in `embark-live' buffers.
;;; Code:
@@ -503,7 +483,7 @@ Meant as :after-until advice for
`embark-collect--metadatum'."
#'embark-consult-imenu-or-outline-candidates
'append)
-;; Automatically preview in live collect buffer
+;; Automatically preview in live collect buffer, see `embark-live'.
(add-hook 'embark-collect-mode-hook
'consult--default-completion-list-preview-setup)