[elpa] externals/consult 90536f39db: change(README): update Live Previews section for custom commands (#631)

[ELPA Syncer]

branch: externals/consult
commit 90536f39db3bd9085971998308ee42176613d68f
Author: Geoffrey Lessel <geoffrey@thelessels.com>
Commit: GitHub <noreply@github.com>

    change(README): update Live Previews section for custom commands (#631)
    
    If a custom command wraps a `consult` command, `this-command` is equal
    to the name of the custom command, even when a `consult-*` command is
    called within it. Since Consult uses the value of `this-command` to
    determine whether or not to show a preview, we have to add the name of
    our custom `consult-*` wrapping command to the `customize-consult`
    call that sets the preview key.
    
    Co-authored-by: Geoffrey Lessel <geo@falken.local>
---
 README.org | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.org b/README.org
index 0b79aacb74..1d11ac3862 100644
--- a/README.org
+++ b/README.org
@@ -427,8 +427,13 @@ following settings are possible:
 - Disabled =nil=
 
 A safe recommendation is to leave automatic immediate previews enabled in
-general and disable the automatic preview only for commands, where the preview
-may be expensive due to file loading.
+general and disable the automatic preview only for commands where the preview
+may be expensive due to file loading. Internally, Consult uses the
+value of =this-command= to determine the =:preview-key=
+customized. This means that if you wrap a =consult-*= command within
+your own function or command, you will also need to add the name of
+/your custom command/ to the =consult-customize= call in order for it
+to be considered.
 
 #+begin_src emacs-lisp
   (consult-customize
@@ -436,6 +441,7 @@ may be expensive due to file loading.
    consult-bookmark consult-recent-file consult-xref
    consult--source-bookmark consult--source-recent-file
    consult--source-project-recent-file
+   ;; my/command-wrapping-consult       ;; disable auto previews inside my 
command
    ;; :preview-key '(:debounce 0.2 any) ;; Option 1: Delay preview
    :preview-key (kbd "M-."))            ;; Option 2: Manual preview
 #+end_src