branch: elpa/helm
commit 3ec22c502c688f61368198f976accc37210eb964
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Update docstring
---
helm-source.el | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/helm-source.el b/helm-source.el
index e411d4ccca3..392eb8d266d 100644
--- a/helm-source.el
+++ b/helm-source.el
@@ -492,7 +492,13 @@
:initform nil
:custom boolean
:documentation
- " Match the real value of candidates when non nil.")
+ "Match the real value of candidates when non nil.
+Note that this assume you are using (DISPLAY . REAL) candidates and
+these candidates are computed as cons cell _before_
+`helm-match-from-candidates' run. This mean you have to compute your
+candidates as cons cell either in the :candidates or :init function or
+in a :candidate-transformer. Expect an error if you compute your
+candidates as cons cell in a :filtered-candidate-transformer.")
(fuzzy-match
:initarg :fuzzy-match
