summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mendler <mail@daniel-mendler.de>2022-04-01 17:08:07 +0200
committerDaniel Mendler <mail@daniel-mendler.de>2022-04-01 17:08:07 +0200
commit04fbfce3d7e9c125a7fd22a34455a508247a522b (patch)
tree61ba85eced33d92bb57d56629ba26e0a829e8b12
parent761d9f55ab4ba68be6240c61a6dffae1c7cdc9a2 (diff)
Expand docstrings
-rw-r--r--corfu.el9
1 files changed, 6 insertions, 3 deletions
diff --git a/corfu.el b/corfu.el
index 6eaeca0..60c96e2 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)