[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/consult 0d0a2f3: Clarify docstring (See #470)
From: |
ELPA Syncer |
Subject: |
[elpa] externals/consult 0d0a2f3: Clarify docstring (See #470) |
Date: |
Tue, 16 Nov 2021 06:57:12 -0500 (EST) |
branch: externals/consult
commit 0d0a2f335889f82e91d96f77d71884ebd554aa62
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Clarify docstring (See #470)
---
README.org | 1 +
consult.el | 6 +++++-
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index ab2aedc..2f3fbb5 100644
--- a/README.org
+++ b/README.org
@@ -584,6 +584,7 @@ their descriptions.
Required source fields:
- =:category= Completion category.
- =:items= List of strings to select from or function returning list of
strings.
+ A list of cons cells is not supported.
Optional source fields:
- =:name= Name of the source, used for narrowing, group titles and
annotations.
diff --git a/consult.el b/consult.el
index d1c0c7d..6cbeb699 100644
--- a/consult.el
+++ b/consult.el
@@ -2136,7 +2136,11 @@ INHERIT-INPUT-METHOD, if non-nil the minibuffer inherits
the input method."
(defun consult--multi (sources &rest options)
"Select from candidates taken from a list of SOURCES.
-OPTIONS is the plist of options passed to `consult--read'.
+OPTIONS is the plist of options passed to `consult--read'. The following
+options are supported: :require-match, :history, :keymap, :initial,
+:add-history, :sort and :inherit-input-method. The other options of
+`consult--read' are used by the implementation of `consult--multi' and should
+be overwritten only in special scenarios.
The function returns the selected candidate in the form (cons candidate
source-value). The sources of the source list can either be symbols of source
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/consult 0d0a2f3: Clarify docstring (See #470),
ELPA Syncer <=