branch: externals/corfu
commit 443905dade3e1c14d181c4e30b8583559c1d60d1
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Minor extension documentation improvements (Fix #167)
---
README.org | 4 +++-
extensions/corfu-indexed.el | 7 ++++---
extensions/corfu-info.el | 6 ++++--
extensions/corfu-quick.el | 2 +-
4 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index f92a68471b..f706e10fba 100644
--- a/README.org
+++ b/README.org
@@ -410,9 +410,11 @@ following extensions come with the Corfu ELPA package:
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-history.el][corfu-history]]:
=corfu-history-mode= to remember selected candidates and to improve sorting.
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-indexed.el][corfu-indexed]]:
=corfu-indexed-mode= to select indexed candidates with prefix arguments.
--
[[https://github.com/minad/corfu/blob/main/extensions/corfu-info.el][corfu-info]]:
Candidate actions to access the candidate location and documentation.
+-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-info.el][corfu-info]]:
Actions to access the candidate location and documentation.
-
[[https://github.com/minad/corfu/blob/main/extensions/corfu-quick.el][corfu-quick]]:
Commands to select using Avy-style quick keys.
+See the Commentary of those files for configuration details.
+
* Complementary packages
Corfu works well together with all packages providing code completion via the
diff --git a/extensions/corfu-indexed.el b/extensions/corfu-indexed.el
index 5b817cde38..feefbf1bdb 100644
--- a/extensions/corfu-indexed.el
+++ b/extensions/corfu-indexed.el
@@ -26,9 +26,10 @@
;;; Commentary:
-;; This package is a Corfu extension, which prefixes candidates with indices
and
-;; allows you to select with prefix arguments. This is designed to be a faster
-;; alternative to selecting a candidate with `corfu-next' and `corfu-previous'.
+;; This package is a Corfu extension, which prefixes candidates with indices if
+;; enabled via `corfu-indexed-mode'. It allows you to select candidates with
+;; prefix arguments. This is designed to be a faster alternative to selecting a
+;; candidate with `corfu-next' and `corfu-previous'.
;;; Code:
diff --git a/extensions/corfu-info.el b/extensions/corfu-info.el
index 14003500a9..e2eff63b48 100644
--- a/extensions/corfu-info.el
+++ b/extensions/corfu-info.el
@@ -26,8 +26,10 @@
;;; Commentary:
-;; This Corfu extension provides commands to show additional information
-;; to the candidates in a separate buffer.
+;; This Corfu extension provides commands to show additional information to the
+;; candidates in a separate buffer. The commands `corfu-info-location' and
+;; `corfu-info-documentation' are bound by default in the `corfu-map' to M-g
and
+;; M-h respectively.
;;; Code:
diff --git a/extensions/corfu-quick.el b/extensions/corfu-quick.el
index df02eccda7..2e0e3e2999 100644
--- a/extensions/corfu-quick.el
+++ b/extensions/corfu-quick.el
@@ -32,7 +32,7 @@
;; alternative to selecting a candidate with `corfu-next' and
;; `corfu-previous'.
;; (define-key corfu-map "\M-q" #'corfu-quick-complete)
-;; (define-key corfu-map "\C-q" #'corfu-quick-exit)
+;; (define-key corfu-map "\C-q" #'corfu-quick-insert)
;;; Code:
