summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mendler <mail@daniel-mendler.de>2024-12-23 15:49:55 +0100
committerDaniel Mendler <mail@daniel-mendler.de>2024-12-23 15:49:55 +0100
commitbbc205c92938b2d504ab54f0766a6e89e3e8409e (patch)
treed06ecd4ccaceb4a218d8dad2e4b99928a4b03f9c
parent19da009bc9df40950e640d6fa419f8619631c91e (diff)
Improve docstring
-rw-r--r--corfu.el9
1 files changed, 4 insertions, 5 deletions
diff --git a/corfu.el b/corfu.el
index a6d1804..744e073 100644
--- a/corfu.el
+++ b/corfu.el
@@ -385,11 +385,10 @@ settings `corfu-auto-delay', `corfu-auto-prefix' and
(defun corfu--capf-wrapper (fun &optional prefix)
"Wrapper for `completion-at-point' FUN.
-The wrapper determines if the Capf is applicable at the current
-position and performs sanity checking on the returned result.
-For non-exclusive Capfs wrapper additionally checks if the
-current input can be completed successfully. PREFIX is a prefix
-length override, set to t for manual completion."
+The wrapper determines if the Capf is applicable at the current position
+and performs sanity checking on the returned result. For non-exclusive
+Capfs, the wrapper checks if the current input can be completed. PREFIX
+is a prefix length override, which is t for manual completion."
(pcase (funcall fun)
((and res `(,beg ,end ,table . ,plist))
(and (integer-or-marker-p beg) ;; Valid Capf result