summaryrefslogtreecommitdiff
path: root/helm-mode.el
diff options
context:
space:
mode:
authorThierry Volpiatto <thievol@posteo.net>2020-09-04 07:43:11 +0200
committerThierry Volpiatto <thievol@posteo.net>2020-09-04 07:43:11 +0200
commit99be8163bc52b3b4d6eb82a6064ade7fb140ebf3 (patch)
treeed1d1877447cd67b22eccb63a5e5b1e8cfb1ad17 /helm-mode.el
parent4f0dc83002c6e2861ffcb3dfb916ddb19114bb50 (diff)
Fix docstring
Diffstat (limited to 'helm-mode.el')
-rw-r--r--helm-mode.el3
1 files changed, 3 insertions, 0 deletions
diff --git a/helm-mode.el b/helm-mode.el
index 9285e89d..87b046df 100644
--- a/helm-mode.el
+++ b/helm-mode.el
@@ -165,6 +165,9 @@ Apply only in `helm-mode' handled commands."
When nil no sorting is done.
The function is a `filtered-candidate-transformer' function which takes
two args CANDIDATES and SOURCE.
+The function must use the flag `helm-completion--sorting-done' and
+return CANDIDATES unchanged when the flag is nil.
+See default function `helm-completion-in-region-sort-fn' as example.
It will be used only when `helm-completion-style' is either Emacs or
helm, otherwise when helm-fuzzy style is used, the fuzzy sort function
will be used."