[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/corfu 04fbfce3d7 2/2: Expand docstrings
From: |
ELPA Syncer |
Subject: |
[elpa] externals/corfu 04fbfce3d7 2/2: Expand docstrings |
Date: |
Fri, 1 Apr 2022 11:57:23 -0400 (EDT) |
branch: externals/corfu
commit 04fbfce3d7e9c125a7fd22a34455a508247a522b
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Expand docstrings
---
corfu.el | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/corfu.el b/corfu.el
index 6eaeca013f..60c96e29c5 100644
--- a/corfu.el
+++ b/corfu.el
@@ -868,7 +868,8 @@ there hasn't been any input, then quit."
(corfu--insert 'exact)))
(defun corfu-insert-separator ()
- "Insert a separator character, inhibiting quit on completion boundary."
+ "Insert a separator character, inhibiting quit on completion boundary.
+See `corfu-separator' for more details."
(interactive)
(insert corfu-separator))
@@ -991,7 +992,8 @@ there hasn't been any input, then quit."
(user-error "No candidate location available")))
(defun corfu-complete ()
- "Try to complete current input."
+ "Try to complete current input.
+If a candidate is selected, insert it."
(interactive)
(pcase-let ((`(,beg ,end ,table ,pred) completion-in-region--data))
(if (>= corfu--index 0)
@@ -1042,7 +1044,8 @@ there hasn't been any input, then quit."
(when exit (funcall exit str status))))
(defun corfu-insert ()
- "Insert current candidate."
+ "Insert current candidate.
+Quit if no candidate is selected."
(interactive)
(if (>= corfu--index 0)
(corfu--insert 'finished)