branch: master
commit 24a63549cc84b4b0f3f9f2475bf1c4bbcc69dcf0
Author: Oleh Krehel <ohwoeo...@gmail.com>
Commit: Oleh Krehel <ohwoeo...@gmail.com>
ivy.el (ivy--format): Improve docstring
Re #2263
---
ivy.el | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ivy.el b/ivy.el
index 8956c87..fea6ad5 100644
--- a/ivy.el
+++ b/ivy.el
@@ -3883,7 +3883,7 @@ Note: The usual last two arguments are flipped for
convenience.")
(defun ivy--format (cands)
"Return a string for CANDS suitable for display in the minibuffer.
-CANDS is a list of strings."
+CANDS is a list of candidates that :display-transformer can turn into strings."
(setq ivy--length (length cands))
(when (>= ivy--index ivy--length)
(ivy-set-index (max (1- ivy--length) 0)))
