Skip to content
Browse files

* helm-help.el: Document candidates-process.

  • Loading branch information...
1 parent fbea83d commit b08bd226aec0cc8a1e85f49346b26fa5f45740bf @thierryvolpiatto thierryvolpiatto committed Nov 26, 2012
Showing with 8 additions and 0 deletions.
  1. +8 −0 helm-help.el
View
8 helm-help.el
@@ -725,11 +725,19 @@ HELM-ATTRIBUTE should be a symbol."
output from it, killing it if necessary, etc.). The process
should return candidates matching the current pattern (see
variable `helm-pattern'.)
+ You should use instead `candidates-process' attribute for
+ async processes, a warning will popup when using async process
+ in a `candidates' attribute.
Note that currently results from asynchronous sources appear
last in the helm buffer regardless of their position in
`helm-sources'.")
+(helm-document-attribute 'candidates-process
+ "Same as `candidates' attributes but for process function."
+ "You should use this attribute when using a function involving
+ an async process instead of `candidates'.")
+
(helm-document-attribute 'action "mandatory if type attribute is not provided"
" It is a list of (DISPLAY . FUNCTION) pairs or FUNCTION.
FUNCTION is called with one parameter: the selected candidate.

0 comments on commit b08bd22

Please sign in to comment.
Something went wrong with that request. Please try again.