[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/consult f31d4f1a3b 4/5: Improve docstrings
From: |
ELPA Syncer |
Subject: |
[elpa] externals/consult f31d4f1a3b 4/5: Improve docstrings |
Date: |
Thu, 5 Dec 2024 12:58:10 -0500 (EST) |
branch: externals/consult
commit f31d4f1a3bc07ef029c76b267ed1737084211cc7
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Improve docstrings
---
consult.el | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/consult.el b/consult.el
index 8592e43d4a..9f65fba529 100644
--- a/consult.el
+++ b/consult.el
@@ -2108,8 +2108,10 @@ INITIAL is the additional initial string."
(defun consult--async-split (async &optional split min-input)
"Create async function, which splits the input string.
ASYNC is the async sink.
-SPLIT is the splitting function.
-MIN-INPUT is the minimum input length."
+SPLIT is the splitting function and defaults to the splitting style
+configured by `consult-async-split-style'.
+MIN-INPUT is the minimum input length and defaults to
+`consult-async-min-input'."
(unless split
(let* ((style (consult--async-split-style))
(fn (plist-get style :function)))
@@ -2368,9 +2370,10 @@ highlighting function."
"Dynamic computation of candidates.
ASYNC is the sink.
FUN computes the candidates given the input.
-DEBOUNCE is the time after which an interrupted computation
-should be restarted.
-MIN-INPUT is the minimal input length."
+DEBOUNCE is the time after which an interrupted computation should be
+restarted and defaults to `consult-async-input-debounce'.
+MIN-INPUT is the minimal input length and defaults to
+`consult-async-min-input'."
(setq debounce (or debounce consult-async-input-debounce)
min-input (or min-input consult-async-min-input)
async (consult--async-indicator async))