branch: master
commit a566403517d9df547bed5611b0f8c67564b3cd1a
Author: Oleh Krehel <[email protected]>
Commit: Oleh Krehel <[email protected]>
ivy.el (ivy-read): Document all args
Fixes #533
---
ivy.el | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/ivy.el b/ivy.el
index 5df305d..d6707e6 100644
--- a/ivy.el
+++ b/ivy.el
@@ -1284,9 +1284,18 @@ escape it with %%. See also `ivy-count-format'.
COLLECTION is either a list of strings, a function, an alist, or
a hash table.
+PREDICATE is applied to filter out the COLLECTION immediately.
+This argument is for `completing-read' compat.
+
+When REQUIRE-MATCH is non-nil, only memebers of COLLECTION can be
+selected, i.e. custom text.
+
If INITIAL-INPUT is not nil, then insert that input in the
minibuffer initially.
+HISTORY is a name of a variable to hold the completion session
+history.
+
KEYMAP is composed with `ivy-minibuffer-map'.
If PRESELECT is not nil, then select the corresponding candidate
