[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/consult 80407622f3 4/4: Update doc string and readme
From: |
ELPA Syncer |
Subject: |
[elpa] externals/consult 80407622f3 4/4: Update doc string and readme |
Date: |
Thu, 16 May 2024 18:57:40 -0400 (EDT) |
branch: externals/consult
commit 80407622f323669c735737272ecbc3b602434b77
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Update doc string and readme
---
README.org | 13 +++++++------
consult.el | 4 ++--
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.org b/README.org
index decd831551..5aaf96f34d 100644
--- a/README.org
+++ b/README.org
@@ -475,11 +475,12 @@ 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. During preview some functionality is disabled to
improve the performance, see for example the customization variables
-=consult-preview-variables= and =consult-preview-allowed-hooks=. Only mode
hooks
-(e.g. =prog-mode-hook=) and find file hooks (=find-file-hook=) listed in
-=consult-preview-allowed-hooks= are executed. In order to enable additional
font
-locking during preview, add the corresponding hooks to the allow list. The
-following code demonstrates this for
[[https://github.com/minad/org-modern][org-modern]] and
[[https://github.com/tarsius/hl-todo][hl-todo]].
+=consult-preview-variables= and =consult-preview-allowed-hooks=. Only hooks
listed
+in =consult-preview-allowed-hooks= are executed. This variable applies to
+=find-file-hook=, =change-major-mode-hook= and mode hooks, e.g.,
=prog-mode-hook=. In
+order to enable additional font locking during preview, add the corresponding
+hooks to the allow list. The following code demonstrates this for
[[https://github.com/minad/org-modern][org-modern]] and
+[[https://github.com/tarsius/hl-todo][hl-todo]].
#+begin_src emacs-lisp
;; local modes added to prog-mode hooks
@@ -923,7 +924,7 @@ an overview of all Consult variables and functions with
their descriptions.
| consult-narrow-key | Narrowing prefix key during completion
|
| consult-point-placement | Placement of the point when jumping to
matches |
| consult-preview-key | Keys which triggers preview
|
-| consult-preview-allowed-hooks | List of hooks to enable during preview
|
+| consult-preview-allowed-hooks | List of hooks to allow during preview
|
| consult-preview-excluded-files | Regexps matched against file names during
preview |
| consult-preview-max-count | Maximum number of files to keep open
during preview |
| consult-preview-partial-size | Files larger than this size are previewed
partially |
diff --git a/consult.el b/consult.el
index e77bd52b53..29efad0412 100644
--- a/consult.el
+++ b/consult.el
@@ -343,8 +343,8 @@ chunk from the beginning of the file is previewed."
'(global-font-lock-mode
save-place-find-file-hook)
"List of hooks, which should be executed during file preview.
-This variable applies to both `find-file-hook', `change-major-mode-hook'
-and mode hooks, e.g., `prog-mode-hook'."
+This variable applies to `find-file-hook', `change-major-mode-hook' and
+mode hooks, e.g., `prog-mode-hook'."
:type '(repeat symbol))
(defcustom consult-preview-variables