[elpa] externals/consult 7dd627e: README: Clarify usage of consult-completion-in-region

[ELPA Syncer]

branch: externals/consult
commit 7dd627efcbd654ed215cd49ab33b62f900268f82
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    README: Clarify usage of consult-completion-in-region
---
 README.org | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/README.org b/README.org
index 836b59e..d71a99b 100644
--- a/README.org
+++ b/README.org
@@ -357,15 +357,16 @@ their descriptions.
    The selected man page is opened using the Emacs =man= command.
  - =consult-file-externally=: Select a file and open it externally,
    e.g. using =xdg-open= on Linux.
- - =consult-completion-in-region=: Function which can be used as
-   =completion-in-region-function=. This way, the minibuffer completion UI will
-   be used for =completion-at-point=. This function is particularily useful in
-   combination with Vertico or Icomplete, since these UIs do not provide their
-   own =completion-in-region-function=. Selectrum already comes with its own
-   function, which is similar to =consult-completion-in-region=. However you 
may
-   not want to transfer the completion at point into the minibuffer and prefer
-   to see the completions directly in the buffer as a small popup. In that case
-   you can either use the [[https://github.com/minad/corfu][Corfu]] or the 
[[https://github.com/company-mode/company-mode][Company]] package.
+ - =consult-completion-in-region=: This function can be set as
+   =completion-in-region-function=. Then the minibuffer completion UI will be 
used
+   for =completion-at-point=. This function is particularily useful in 
combination
+   with Vertico or Icomplete, since these UIs do not provide their own
+   =completion-in-region-function=. Selectrum already comes with its own 
function
+   similar to =consult-completion-in-region=. Note that
+   =consult-completion-in-region= is not useful if the default =*Completions*=
+   UI is used. Furthermore you may prefer to see the completions directly in 
the
+   buffer as a small popup. In that case you can either use the 
[[https://github.com/minad/corfu][Corfu]] or the
+   [[https://github.com/company-mode/company-mode][Company]] package.
  - =consult-theme=: Select a theme and disable all currently enabled
    themes. Supports live preview of the theme while scrolling through the
    candidates.