branch: externals/consult
commit 8e4e4fadc27dd48269f607e9d290ccff3353a3e3
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
consult--read: Update docstring, update changelog
---
CHANGELOG.org | 8 +++++++-
consult.el | 2 +-
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.org b/CHANGELOG.org
index 7771f80d60..b0c4beb476 100644
--- a/CHANGELOG.org
+++ b/CHANGELOG.org
@@ -21,9 +21,15 @@
- BREAKING API CHANGE of =consult--read=, =consult--prompt=, =consult--multi=:
The
state function protocol changed. The function gets notified of more
completion
state changes. See the docstring of =consult--with-preview= for details.
+- BREAKING API CHANGE of =consult--read=: The lookup function protocol changed.
+ The lookup function must now take keyword arguments.
- Remove unused =consult-preview-map=.
- Remove unnecessary =consult-recent-file-filter=. Use =recentf-exclude=
instead.
-- =consult--multi= sources can have a =:new= function now to create candidates.
+- =consult--multi= sources can have a =:new= function to create candidates.
+ When narrowed to a source, new candidates will be created by calling the
+ respective =:new= function.
+- =consult--multi= returns =:match= information. =:match= can be nil, t, or
new,
+ depending on if the candidate does not exist, exists or has been created.
* Version 0.16 (2022-03-08)
diff --git a/consult.el b/consult.el
index 7c13b4c859..541e52dd50 100644
--- a/consult.el
+++ b/consult.el
@@ -2217,7 +2217,7 @@ DEFAULT is the default selected value.
ADD-HISTORY is a list of items to add to the history.
CATEGORY is the completion category.
SORT should be set to nil if the candidates are already sorted.
-LOOKUP is a lookup function passed the input, candidates and candidate string.
+LOOKUP is a lookup function passed the :input, :selected, :narrow and
:candidates keys.
ANNOTATE is a function passed a candidate string to return an annotation.
INITIAL is the initial input.
STATE is the state function, see `consult--with-preview'.
