branch: elpa/helm
commit c9a6c2542e5ec48700d1a72632cef009e5ee3253
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Add helm-match-from-candidates docstring
---
helm-core.el | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/helm-core.el b/helm-core.el
index d5f19c7bd3d..522e50f373c 100644
--- a/helm-core.el
+++ b/helm-core.el
@@ -5017,6 +5017,14 @@ emacs-27 to provide such scoring in emacs<27."
searchfns (list searchfns))))
(defun helm-match-from-candidates (cands matchfns match-part-fn limit source)
+ "Filter CANDS list in SOURCE with functions in MATCHFNS.
+If MATCH-PART-FN is a valid function, use it to determine in each
+candidate of CANDS the part of candidate we want to match on (see the
+:match-part documentation in `helm-source'). When LIMIT in CANDS is
+reached, stop and return the filtered list. This function is used only
+by sync sources, i.e. sources built with `helm-source-sync', see
+`helm-search-from-candidate-buffer' for `helm-source-in-buffer' sources
+and `helm-output-filter' for async sources."
(when cands ; nil in async sources.
(condition-case-unless-debug err
(cl-loop with hash = (make-hash-table :test 'equal)
