[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 7299950 16/31: ivy.el: Fixup docstrings
From: |
Oleh Krehel |
Subject: |
[elpa] master 7299950 16/31: ivy.el: Fixup docstrings |
Date: |
Fri, 01 May 2015 14:28:52 +0000 |
branch: master
commit 729995055cb2206872a828f790bd9ccd25d6b188
Author: Oleh Krehel <address@hidden>
Commit: Oleh Krehel <address@hidden>
ivy.el: Fixup docstrings
* ivy.el (ivy-require-match): Update.
(ivy-def): Update.
(ivy--prompt-extra): Update.
(ivy--maybe-scroll-history): Update.
(ivy-completing-read): Update.
(ivy--insert-minibuffer): Update.
(ivy--filter): Update.
---
ivy.el | 13 +++++++------
1 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/ivy.el b/ivy.el
index 5b440f3..d9b51e2 100644
--- a/ivy.el
+++ b/ivy.el
@@ -124,10 +124,10 @@ Maximum length of the history list is determined by the
value
of `history-length', which see.")
(defvar ivy-require-match t
- "Store require-match. See `completing-read'.")
+ "Store require-match. See `completing-read'.")
(defvar ivy-def nil
- "Store the default completion value. See `completing-read'.")
+ "Store the default completion value. See `completing-read'.")
(defvar ivy--directory nil
"Current directory when completing file names.")
@@ -171,7 +171,7 @@ Otherwise, store nil.")
When non-nil, it should contain one %d.")
(defvar ivy--prompt-extra ""
- "Temporary modifications to the prompt")
+ "Temporary modifications to the prompt.")
(defvar ivy--old-re nil
"Store the old regexp.")
@@ -341,7 +341,7 @@ If the input is empty, select the previous history element
instead."
(ivy--maybe-scroll-history))
(defun ivy--maybe-scroll-history ()
- "If the selected history element holds an index, scroll there."
+ "If the selected history element has an index, scroll there."
(let ((idx (ignore-errors
(get-text-property
(minibuffer-prompt-end)
@@ -579,7 +579,7 @@ PROMPT is a string to prompt with; normally it ends in a
colon and a space.
COLLECTION can be a list of strings, an alist, an obarray or a hash table.
PREDICATE limits completion to a subset of COLLECTION.
-REQUIRE-MATCH is stored into `ivy-require-match'. See `completing-read'.
+REQUIRE-MATCH is stored into `ivy-require-match'. See `completing-read'.
INITIAL-INPUT is a string that can be inserted into the minibuffer initially.
_HISTORY is ignored for now.
DEF is the default value.
@@ -789,6 +789,7 @@ Should be run via minibuffer `post-command-hook'."
(ivy--filter ivy-text ivy--all-candidates)))))
(defun ivy--insert-minibuffer (text)
+ "Insert TEXT into minibuffer with appropriate cleanup."
(ivy--cleanup)
(let ((buffer-undo-list t)
deactivate-mark)
@@ -814,7 +815,7 @@ Should be run via minibuffer `post-command-hook'."
str)
(defun ivy--filter (name candidates)
- "Return the matches for NAME for CANDIDATES.
+ "Return all items that match NAME in CANDIDATES.
CANDIDATES are assumed to be static."
(let* ((re (funcall ivy--regex-function name))
(cands (cond ((and (equal re ivy--old-re)
- [elpa] master 94fad10 06/31: Improve the match confirm while completing files, (continued)
- [elpa] master 94fad10 06/31: Improve the match confirm while completing files, Oleh Krehel, 2015/05/01
- [elpa] master c816430 07/31: Minibuffer faces should inherit minibuffer-prompt, Oleh Krehel, 2015/05/01
- [elpa] master b2c9a20 09/31: Store the preselect and use it for empty ivy-text, Oleh Krehel, 2015/05/01
- [elpa] master 988b78f 08/31: Improve completion history using the propertize trick, Oleh Krehel, 2015/05/01
- [elpa] master eb43e4a 10/31: ivy.el (ivy-alt-done): Treat `ivy-text' with ":" verbatim, Oleh Krehel, 2015/05/01
- [elpa] master 00810d6 11/31: ivy.el (ivy--filter): Fixup, Oleh Krehel, 2015/05/01
- [elpa] master 7f04019 12/31: swiper.el (swiper-font-lock-ensure): Exclude `elfeed-search-mode', Oleh Krehel, 2015/05/01
- [elpa] master 278870e 13/31: Use alpha compositing to add ivy-current-match face, Oleh Krehel, 2015/05/01
- [elpa] master 57de44c 14/31: Makefile: Update, Oleh Krehel, 2015/05/01
- [elpa] master 56d7802 15/31: Add an option for multi-tier regex matching, Oleh Krehel, 2015/05/01
- [elpa] master 7299950 16/31: ivy.el: Fixup docstrings,
Oleh Krehel <=
- [elpa] master aa9d4a7 17/31: ivy.el (ivy-re-builders-alist): Improve doc, Oleh Krehel, 2015/05/01
- [elpa] master 0f141f5 18/31: counsel.el (counsel-git-grep): Add optional initial-input, Oleh Krehel, 2015/05/01
- [elpa] master 23ffa25 19/31: Bind "TAB" to do partial completion, Oleh Krehel, 2015/05/01
- [elpa] master ae2fd1a 21/31: Improve hidden buffer completion further, Oleh Krehel, 2015/05/01
- [elpa] master 5dc26fb 20/31: Improve the completion of hidden buffers, Oleh Krehel, 2015/05/01
- [elpa] master 1332b19 22/31: ivy.el (ivy--exhibit): Fixup last commit, Oleh Krehel, 2015/05/01
- [elpa] master 6b2e95a 24/31: Add gamma-correction to alpha-blending, Oleh Krehel, 2015/05/01
- [elpa] master a868705 23/31: colir.el: Add two additional blend algorithms, Oleh Krehel, 2015/05/01
- [elpa] master 7bd6003 25/31: Update and improve faces, Oleh Krehel, 2015/05/01
- [elpa] master 94b6a83 26/31: Don't error on bad regex, Oleh Krehel, 2015/05/01