branch: externals/vertico
commit 0831da48fe75a173a27eb1ff2837777c80f0a2f4
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Minor extension documentation improvements
---
extensions/vertico-indexed.el | 6 ++++--
extensions/vertico-quick.el | 6 +++++-
2 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/extensions/vertico-indexed.el b/extensions/vertico-indexed.el
index 6bdf030a1b..ed0268c098 100644
--- a/extensions/vertico-indexed.el
+++ b/extensions/vertico-indexed.el
@@ -26,8 +26,10 @@
;;; Commentary:
-;; This package is a Vertico extension, which prefixes candidates with
-;; indices and allows you to select with prefix arguments.
+;; This package is a Vertico extension, which prefixes candidates with indices
+;; if enabled via `vertico-indexed-mode'. It allows you to select candidates
+;; with prefix arguments. This is designed to be a faster alternative to
+;; selecting a candidate with `vertico-next' and `vertico-previous'.
;;; Code:
diff --git a/extensions/vertico-quick.el b/extensions/vertico-quick.el
index 6c8146f066..539607f891 100644
--- a/extensions/vertico-quick.el
+++ b/extensions/vertico-quick.el
@@ -26,7 +26,11 @@
;;; Commentary:
-;; This package is a Vertico extension, which provides quick keys.
+;; This package is a Vertico extension, which prefixes candidates with
+;; quick keys. Typing these quick keys allows you to select the
+;; candidate in front of them. This is designed to be a faster
+;; alternative to selecting a candidate with `vertico-next' and
+;; `vertico-previous'.
;; (define-key vertico-map "\M-q" #'vertico-quick-insert)
;; (define-key vertico-map "\C-q" #'vertico-quick-exit)
