branch: externals/consult
commit 7b324c597406b77eb18591bb3ce23b2078eb992e
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
README: Expand section about live previews (Fix #323)
---
README.org | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/README.org b/README.org
index e9edc7f..f51d7b2 100644
--- a/README.org
+++ b/README.org
@@ -410,6 +410,27 @@ their descriptions.
=:preview-key=, such that preview can be manual for some commands, for some
commands automatic and for some commands completely disabled.
+ A safe recommendation is to leave automatic previews enabled in general and
+ disable the automatic preview only for commands, where the preview may be
+ expensive due to file loading.
+
+ #+begin_src emacs-lisp
+ (consult-customize
+ consult-ripgrep consult-git-grep consult-grep
+ consult-bookmark consult-recent-file consult-xref
+ consult--source-file consult--source-project-file consult--source-bookmark
+ :preview-key (kbd "M-."))
+ #+end_src
+
+ In this case one may wonder what the difference is between using an Embark
+ action on the current candidate in comparison to a manually triggered preview.
+ The main difference is that the files opened by manual preview are closed
again
+ after the completion session. Furthermore during preview some functionality is
+ disabled to improve the performance, see for example
+ =consult-preview-excluded-hooks=. Files larger than =consult-preview-raw-size=
+ are previewed literally without syntax highlighting and without changing the
+ major mode.
+
** Narrowing and grouping
:properties:
:description: Restricting the completion to a candidate group
