[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/vcomplete 7cd781f7f3 59/91: ; Documentation improvements
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/vcomplete 7cd781f7f3 59/91: ; Documentation improvements |
Date: |
Tue, 24 May 2022 15:59:09 -0400 (EDT) |
branch: elpa/vcomplete
commit 7cd781f7f35d6561e0ca31d1639a1dc01e8a6223
Author: Daniel Semyonov <daniel@dsemy.com>
Commit: Daniel Semyonov <daniel@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.
- [nongnu] elpa/vcomplete 8441803b7a 38/91: Split 'vcomplete--setup-current' into two functions, (continued)
- [nongnu] elpa/vcomplete 8441803b7a 38/91: Split 'vcomplete--setup-current' into two functions, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 50d812fc6a 39/91: Remove unnecessary hook removal, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 6684bd7640 41/91: ; Update info node to remove disclaimer for bug fixed in last commit, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete b14444ef8a 45/91: ; Edit docstrings to conform completely to 'checkdoc', ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 371e7c9b77 46/91: ; Add requirement for Embark to vcomplete-embark.el, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete d086a33a1a 49/91: * vcomplete.el (vcomplete-with-completions-buffer): Use 'derived-mode-p', ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 20e327acce 53/91: ; Indicate that Embark integration has been moved in the NEWS file, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 89fd222097 56/91: ; Improve docstring of 'vcomplete--disable-completion-in-region', ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 45adfdd13e 55/91: ; Document last commit in the NEWS file, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete a64c37e780 89/91: ; Generate 'vcomplete-pkg.el' automatically, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 7cd781f7f3 59/91: ; Documentation improvements,
ELPA Syncer <=
- [nongnu] elpa/vcomplete 60b5a005bf 22/91: ; Add last few changes to NEWS file, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 5e055dc556 30/91: Fix cases where 'completion-in-region-mode' is used in the minibuffer, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 21edba4beb 01/91: Initial commit, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete faca6e8c18 32/91: ; Change all instances of "‘" and "’" to "`" and "'" respectively, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete db010f4f61 34/91: Mark variables as risky local variables, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 5fefec3e91 40/91: Fix broken highlighting in completion list buffers when completing in-region, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 6136a3ba16 42/91: ; Update NEWS file, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete 8ade381c7c 44/91: Move Embark integration to a separate file, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete b8402112ba 60/91: ; Remove unnecessary declaration, ELPA Syncer, 2022/05/24
- [nongnu] elpa/vcomplete b30cedbf26 65/91: ; Fix small style issue in info file, ELPA Syncer, 2022/05/24