[elpa] externals/consult c8bedba 1/3: README: Add note about consult-completion-in-region

[ELPA Syncer]

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

    README: Add note about consult-completion-in-region
---
 README.org | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/README.org b/README.org
index 9a04326..4dd5d26 100644
--- a/README.org
+++ b/README.org
@@ -376,9 +376,14 @@ their descriptions.
                                             #'completion--in-region))))
    #+end_src
    Instead of =consult-completion-in-region=, you may prefer to see the
-   completions directly in the buffer as a small popup. In that case, I 
recommed
-   either the [[https://github.com/minad/corfu][Corfu]] or the 
[[https://github.com/company-mode/company-mode][Company]] package.
-
+   completions directly in the buffer as a small popup. In that case, I
+   recommend either the [[https://github.com/minad/corfu][Corfu]] or the 
[[https://github.com/company-mode/company-mode][Company]] package. There is a 
technical
+   caveat of =consult-completion-in-region= in combination with Lsp-mode or 
Eglot.
+   The Lsp server relies on the input at point, in order to generate refined
+   candidate strings. Since the completion is transferred from the original
+   buffer to the minibuffer, the server does not receive the updated input. Lsp
+   completion should work with Corfu or Company though, which perform the
+   completion directly in the original buffer.
 * Special features
   :properties:
   :description: Enhancements over built-in `completing-read'