branch: elpa/vcomplete
commit 29423a4aa11b6098e881cf300101af31125a7543
Author: Daniel Semyonov <dan...@dsemy.com>
Commit: Daniel Semyonov <dan...@dsemy.com>
; Documentation improvements
---
vcomplete.el | 5 ++---
vcomplete.texi | 8 ++++++--
2 files changed, 8 insertions(+), 5 deletions(-)
diff --git a/vcomplete.el b/vcomplete.el
index 8eea9d7223..f97b2ea671 100644
--- a/vcomplete.el
+++ b/vcomplete.el
@@ -95,7 +95,7 @@ Otherwise, operate according to `completion-auto-help'."
(defmacro vcomplete-with-completions-buffer (&rest body)
"Evaluate BODY with the `*Completions*' buffer temporarily current.
-While evaluating body, BUFFER and WINDOW are locally bound to the
+While evaluating BODY, BUFFER and WINDOW are locally bound to the
`*Completions*' buffer and window respectively."
(declare (indent 0))
`(when-let ((buffer (get-buffer "*Completions*"))
@@ -261,8 +261,7 @@ With prefix argument N, move N items (negative N means move
forward)."
;;;###autoload
(define-minor-mode vcomplete-mode
- "Minor mode enhancing the default completion list buffer, providing
-visual aids for selecting completions and performing other actions.
+ "Minor mode enhancing interaction with default completion list buffer.
The following bindings are active during in-buffer and minibuffer
completion:
diff --git a/vcomplete.texi b/vcomplete.texi
index 11b5356dbf..1a78e2c0de 100644
--- a/vcomplete.texi
+++ b/vcomplete.texi
@@ -194,7 +194,11 @@ be done through the customize interface:
Whether the @code{*Completions*} buffer should open and update
automatically. Non-nil means automatically open and
update. Otherwise, operate according to
-@code{completion-auto-help}. By default, @code{t} is used.
+@code{completion-auto-help}. By default, @code{t} is used. Note that
+with @code{completions-detailed} (introduced in Emacs 28) enabled, the
+@code{*Completions*} buffer takes much more time to display. This is
+also true for other ``annotation providers'' such as the Marginalia
+package. Consider disabling them or this option on slow computers.
@end defopt
@menu
@@ -226,7 +230,7 @@ it is called isn't derived from @code{completion-list-mode}.
@defmac vcomplete-with-completions-buffer body...
Evaluate BODY with the @code{*Completions*} buffer temporarily
-current. While evaluating body, BUFFER and WINDOW are locally bound
+current. While evaluating BODY, BUFFER and WINDOW are locally bound
to the @code{*Completions*} buffer and window respectively. This macro
can be used to easily manipulate or access the contents of the
@code{*Completions*} buffer.
