[elpa] externals/ivy-hydra 84dfbf8 296/395: ivy-avy.el: Checkdoc

[Basil L. Contovounesios]

branch: externals/ivy-hydra
commit 84dfbf828088950e9582bbf3c0e04c0bdd97c1f5
Author: Oleh Krehel <ohwoeowho@gmail.com>
Commit: Oleh Krehel <ohwoeowho@gmail.com>

    ivy-avy.el: Checkdoc
---
 ivy-avy.el | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/ivy-avy.el b/ivy-avy.el
index 8939da5..1e5b6f4 100644
--- a/ivy-avy.el
+++ b/ivy-avy.el
@@ -37,6 +37,7 @@
   :group 'ivy)
 
 (defun ivy--avy-candidates ()
+  "List of candidates for `ivy-avy'."
   (let (candidates)
     (save-excursion
       (save-restriction
@@ -54,6 +55,7 @@
     (nreverse candidates)))
 
 (defun ivy--avy-action (pt)
+  "Select the candidate represented by PT."
   (when (number-or-marker-p pt)
     (let ((bnd (ivy--minibuffer-index-bounds
                 ivy--index ivy--length ivy-height)))
@@ -62,6 +64,7 @@
         (nth (+ (car bnd) (- (line-number-at-pos pt) 2)) ivy--old-cands))))))
 
 (defun ivy--avy-handler-function (char)
+  "Handle CHAR that's not on `avy-keys'."
   (let (cmd)
     (cond ((memq char '(?\C-\[ ?\C-g))
            ;; exit silently
@@ -99,3 +102,5 @@
 (add-to-list 'avy-styles-alist `(ivy-avy . ,ivy-avy-style))
 
 (provide 'ivy-avy)
+
+;;; ivy-avy.el ends here