branch: elpa/vcomplete
commit 7cd781f7f35d6561e0ca31d1639a1dc01e8a6223
Author: Daniel Semyonov <dan...@dsemy.com>
Commit: Daniel Semyonov <dan...@dsemy.com>
; Documentation improvements
---
vcomplete.el | 4 +++-
vcomplete.texi | 8 +++++---
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/vcomplete.el b/vcomplete.el
index 88537e459f..10140d6707 100644
--- a/vcomplete.el
+++ b/vcomplete.el
@@ -121,7 +121,9 @@ While evaluating BODY, BUFFER and WINDOW are locally bound
to the
"Get the completion candidate at POS.
The completion candidate is returned as a list of the form:
(COMPLETION-STRING . (BEGINNING . END))
-If no completion is found, return nil."
+If no completion is found, return nil.
+An error is thrown when the current buffer
+isn't a completion list buffer."
(unless (derived-mode-p 'completion-list-mode)
(error "Not in a valid completion list buffer"))
;; Modified from code in `choose-completion'.
diff --git a/vcomplete.texi b/vcomplete.texi
index 7b7c8bc1a0..f3722b6664 100644
--- a/vcomplete.texi
+++ b/vcomplete.texi
@@ -128,8 +128,7 @@ Install the package:
@node Usage
@chapter Usage
-In order to use any feature of the package, @code{vcomplete-mode} must
-be enabled:
+It is recommended for @code{vcomplete-mode} to be enabled:
@cindex vcomplete-mode
@table @asis
@@ -141,7 +140,8 @@ When @code{vcomplete-mode} is enabled, the
@code{*Completions*} buffer
appears and updates automatically (by default), and the completion at
point in the @code{*Completions*} buffer is highlighted automatically.
-The following commands are available when completion is in progress:
+The following commands are also made available when completion is in
+progress:
@kindex C-n
@cindex vcomplete-next-completion
@@ -173,6 +173,8 @@ Choose the currently highlighted completion in the
@code{*Completions*} buffer (@code{vcomplete-choose-completion}).
@end table
+You may use these commands without enabling @code{vcomplete-mode}
+(although they won't be bound by default).
@xref{Completion commands} for information regarding defining new
commands.
