branch: master
commit 06d299fbc48329dec8d73db089e9aa401960625c
Author: fabacino <[email protected]>
Commit: Oleh Krehel <[email protected]>
swiper.el: Fix checkdoc warnings
---
swiper.el | 28 +++++++++++++++++++++-------
1 file changed, 21 insertions(+), 7 deletions(-)
diff --git a/swiper.el b/swiper.el
index 53a9718..e7dfee2 100644
--- a/swiper.el
+++ b/swiper.el
@@ -225,7 +225,7 @@
"Create a fake cursor for each `swiper' candidate."
(interactive)
(unless (require 'multiple-cursors nil t)
- (error "multiple-cursors isn't installed"))
+ (error "Multiple-cursors isn't installed"))
(unless (window-minibuffer-p)
(error "Call me only from `swiper'"))
(let ((cands (nreverse ivy--old-cands)))
@@ -283,10 +283,10 @@
circe-query-mode
sauron-mode
w3m-mode)
- "List of major-modes that are incompatible with font-lock-ensure.")
+ "List of major-modes that are incompatible with `font-lock-ensure'.")
(defun swiper-font-lock-ensure-p ()
- "Return non-nil if we should font-lock-ensure."
+ "Return non-nil if we should `font-lock-ensure'."
(or (derived-mode-p 'magit-mode)
(bound-and-true-p magit-blame-mode)
(memq major-mode swiper-font-lock-exclude)))
@@ -453,7 +453,7 @@ When REVERT is non-nil, regenerate the current *ivy-occur*
buffer."
(defun swiper--re-builder (str)
"Transform STR into a swiper regex.
This is the regex used in the minibuffer where candidates have
-line numbers. For the buffer, use `ivy--regex' instead."
+line numbers. For the buffer, use `ivy--regex' instead."
(let* ((re-builder
(or (cdr (assoc 'swiper ivy-re-builders-alist))
(cdr (assoc t ivy-re-builders-alist))))
@@ -482,7 +482,7 @@ line numbers. For the buffer, use `ivy--regex' instead."
(replace-regexp-in-string "\t" " " (caar re)))
re)
(t
- (error "unexpected")))))
+ (error "Unexpected")))))
(defvar swiper-history nil
"History for `swiper'.")
@@ -534,7 +534,7 @@ When non-nil, INITIAL-INPUT is the initial search pattern."
(setq ivy--old-re nil))
(defun swiper--face-matcher (regexp candidates)
- "Return REGEXP-matching CANDIDATES.
+ "Return REGEXP matching CANDIDATES.
Matched candidates should have `swiper-invocation-face'."
(cl-remove-if-not
(lambda (x)
@@ -670,6 +670,9 @@ WND, when specified is the window."
(cl-incf i))))))))))
(defun swiper--add-overlay (beg end face wnd priority)
+ "Add overlay bound by BEG and END to `swiper--overlays'.
+FACE, WND and PRIORITY are properties corresponding to
+the face, window and priority of the overlay."
(let ((overlay (make-overlay beg end)))
(push overlay swiper--overlays)
(overlay-put overlay 'face face)
@@ -743,6 +746,7 @@ WND, when specified is the window."
"Store the list of candidates for `swiper-multi'.")
(defun swiper-multi-prompt ()
+ "Return prompt for `swiper-multi'."
(format "Buffers (%s): "
(mapconcat #'identity swiper-multi-buffers ", ")))
@@ -761,6 +765,10 @@ Run `swiper' for those buffers."
:caller 'swiper-multi))
(defun swiper-multi-action-1 (x)
+ "Add X to list of selected buffers `swiper-multi-buffers'.
+If X is already part of the list, remove it instead. Quit the selection if
+X is selected by either `ivy-done', `ivy-alt-done' or `ivy-immediate-done',
+otherwise continue prompting for buffers."
(if (member x swiper-multi-buffers)
(progn
(setq swiper-multi-buffers (delete x swiper-multi-buffers)))
@@ -780,6 +788,7 @@ Run `swiper' for those buffers."
(delete-minibuffer-contents)))))
(defun swiper-multi-action-2 (x)
+ "Move to candidate X from `swiper-multi'."
(when (> (length x) 0)
(let ((buffer-name (get-text-property 0 'buffer x)))
(when buffer-name
@@ -816,6 +825,7 @@ Run `swiper' for those buffers."
;;* `swiper-all'
(defun swiper-all-function (str)
+ "Search in all open buffers for STR."
(if (and (< (length str) 3))
(list "" (format "%d chars more" (- 3 (length ivy-text))))
(let* ((buffers (cl-remove-if-not #'swiper-all-buffer-p (buffer-list)))
@@ -856,6 +866,8 @@ Run `swiper' for those buffers."
(defvar swiper-window-width 80)
(defun swiper--all-format-function (cands)
+ "Format CANDS for `swiper-all'.
+See `ivy-format-function' for further information."
(let* ((ww swiper-window-width)
(col2 1)
(cands-with-buffer
@@ -893,7 +905,7 @@ Run `swiper' for those buffers."
;;;###autoload
(defun swiper-all ()
- "Run `swiper' for all opened buffers."
+ "Run `swiper' for all open buffers."
(interactive)
(let* ((swiper-window-width (- (frame-width) (if (display-graphic-p) 0 1)))
(ivy-format-function #'swiper--all-format-function))
@@ -907,6 +919,7 @@ Run `swiper' for those buffers."
:caller 'swiper-multi)))
(defun swiper-all-action (x)
+ "Move to candidate X from `swiper-all'."
(when (> (length x) 0)
(let ((buffer-name (get-text-property 0 'buffer x)))
(when buffer-name
@@ -920,6 +933,7 @@ Run `swiper' for those buffers."
(swiper--add-overlays (ivy--regex ivy-text))))))))
(defun swiper--multi-candidates (buffers)
+ "Extract candidates from BUFFERS."
(let* ((ww (window-width))
(res nil)
(column-2 (apply #'max
