[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/evil 0aaf5944db: doc: follow the Emacs Lisp Style Guide
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/evil 0aaf5944db: doc: follow the Emacs Lisp Style Guide |
|
Date: |
Thu, 29 Sep 2022 09:58:48 -0400 (EDT) |
branch: elpa/evil
commit 0aaf5944db224f1d8948acac64e2b703ed151446
Author: dalu <25452934+dalugm@users.noreply.github.com>
Commit: Tom Dalziel <33435574+tomdl89@users.noreply.github.com>
doc: follow the Emacs Lisp Style Guide
---
evil-commands.el | 136 +++++++++++++++++++++++++++----------------------------
evil-common.el | 90 ++++++++++++++++++------------------
evil-core.el | 4 +-
evil-ex.el | 24 +++++-----
evil-jumps.el | 4 +-
evil-repeat.el | 20 ++++----
evil-search.el | 10 ++--
evil-types.el | 2 +-
evil-vars.el | 12 ++---
9 files changed, 151 insertions(+), 151 deletions(-)
diff --git a/evil-commands.el b/evil-commands.el
index e4e679f395..d814ad76e5 100644
--- a/evil-commands.el
+++ b/evil-commands.el
@@ -1010,7 +1010,7 @@ In Insert state, insert a newline and indent."
;; scrolling
(evil-define-command evil-scroll-line-up (count)
- "Scrolls the window COUNT lines upwards."
+ "Scroll the window COUNT lines upwards."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1018,7 +1018,7 @@ In Insert state, insert a newline and indent."
(scroll-down count)))
(evil-define-command evil-scroll-line-down (count)
- "Scrolls the window COUNT lines downwards."
+ "Scroll the window COUNT lines downwards."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1026,7 +1026,7 @@ In Insert state, insert a newline and indent."
(scroll-up count)))
(evil-define-command evil-scroll-count-reset ()
- "Sets `evil-scroll-count' to 0.
+ "Set `evil-scroll-count' to 0.
`evil-scroll-up' and `evil-scroll-down' will scroll
for a half of the screen(default)."
:repeat nil
@@ -1035,7 +1035,7 @@ for a half of the screen(default)."
(setq evil-scroll-count 0))
(evil-define-command evil-scroll-up (count)
- "Scrolls the window and the cursor COUNT lines upwards.
+ "Scroll the window and the cursor COUNT lines upwards.
If COUNT is not specified the function scrolls down
`evil-scroll-count', which is the last used count.
If the scroll count is zero the command scrolls half the screen."
@@ -1061,7 +1061,7 @@ If the scroll count is zero the command scrolls half the
screen."
(beginning-of-buffer)))))))
(evil-define-command evil-scroll-down (count)
- "Scrolls the window and the cursor COUNT lines downwards.
+ "Scroll the window and the cursor COUNT lines downwards.
If COUNT is not specified the function scrolls down
`evil-scroll-count', which is the last used count.
If the scroll count is zero the command scrolls half the screen."
@@ -1101,7 +1101,7 @@ If the scroll count is zero the command scrolls half the
screen."
(recenter (- (max 1 scroll-margin)))))))))
(evil-define-command evil-scroll-page-up (count)
- "Scrolls the window COUNT pages upwards."
+ "Scroll the window COUNT pages upwards."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1115,7 +1115,7 @@ If the scroll count is zero the command scrolls half the
screen."
(goto-char (point-min))))))))
(evil-define-command evil-scroll-page-down (count)
- "Scrolls the window COUNT pages downwards."
+ "Scroll the window COUNT pages downwards."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1129,7 +1129,7 @@ If the scroll count is zero the command scrolls half the
screen."
(goto-char (point-max))))))))
(evil-define-command evil-scroll-line-to-top (count)
- "Scrolls line number COUNT (or the cursor line) to the top of the window."
+ "Scroll line number COUNT (or the cursor line) to the top of the window."
:repeat nil
:keep-visual t
(interactive "<c>")
@@ -1140,7 +1140,7 @@ If the scroll count is zero the command scrolls half the
screen."
(recenter (1- (max 1 scroll-margin)))))
(evil-define-command evil-scroll-line-to-center (count)
- "Scrolls line number COUNT (or the cursor line) to the center of the window."
+ "Scroll line number COUNT (or the cursor line) to the center of the window."
:repeat nil
:keep-visual t
(interactive "<c>")
@@ -1151,7 +1151,7 @@ If the scroll count is zero the command scrolls half the
screen."
(recenter nil)))
(evil-define-command evil-scroll-line-to-bottom (count)
- "Scrolls line number COUNT (or the cursor line) to the bottom of the window."
+ "Scroll line number COUNT (or the cursor line) to the bottom of the window."
:repeat nil
:keep-visual t
(interactive "<c>")
@@ -1162,7 +1162,7 @@ If the scroll count is zero the command scrolls half the
screen."
(recenter (- (max 1 scroll-margin)))))
(evil-define-command evil-scroll-bottom-line-to-top (count)
- "Scrolls the line right below the window,
+ "Scroll the line right below the window,
or line COUNT to the top of the window."
:repeat nil
:keep-visual t
@@ -1177,7 +1177,7 @@ or line COUNT to the top of the window."
(evil-first-non-blank))
(evil-define-command evil-scroll-top-line-to-bottom (count)
- "Scrolls the line right below the window,
+ "Scroll the line right below the window,
or line COUNT to the top of the window."
:repeat nil
:keep-visual t
@@ -1191,7 +1191,7 @@ or line COUNT to the top of the window."
(evil-first-non-blank))
(evil-define-command evil-scroll-left (count)
- "Scrolls the window COUNT half-screenwidths to the left."
+ "Scroll the window COUNT half-screenwidths to the left."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1199,7 +1199,7 @@ or line COUNT to the top of the window."
(scroll-right (* count (/ (window-width) 2)))))
(evil-define-command evil-scroll-right (count)
- "Scrolls the window COUNT half-screenwidths to the right."
+ "Scroll the window COUNT half-screenwidths to the right."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1207,7 +1207,7 @@ or line COUNT to the top of the window."
(scroll-left (* count (/ (window-width) 2)))))
(evil-define-command evil-scroll-column-left (count)
- "Scrolls the window COUNT columns to the left."
+ "Scroll the window COUNT columns to the left."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1215,7 +1215,7 @@ or line COUNT to the top of the window."
(scroll-right count)))
(evil-define-command evil-scroll-column-right (count)
- "Scrolls the window COUNT columns to the right."
+ "Scroll the window COUNT columns to the right."
:repeat nil
:keep-visual t
(interactive "p")
@@ -1461,7 +1461,7 @@ or line COUNT to the top of the window."
;;; Operator commands
(evil-define-operator evil-yank (beg end type register yank-handler)
- "Saves the characters in motion into the kill-ring."
+ "Save the characters in motion into the kill-ring."
:move-point nil
:repeat nil
(interactive "<R><x><y>")
@@ -1480,7 +1480,7 @@ or line COUNT to the top of the window."
(evil-yank-characters beg end register yank-handler)))))
(evil-define-operator evil-yank-line (beg end type register)
- "Saves whole lines into the kill-ring."
+ "Save whole lines into the kill-ring."
:motion evil-line-or-visual-line
:move-point nil
(interactive "<R><x>")
@@ -2087,7 +2087,7 @@ The default for width is the value of `fill-column'."
fill-column)))
(evil-define-operator evil-align-center (beg end type &optional width)
- "Centers lines in the region between WIDTH columns.
+ "Center lines in the region between WIDTH columns.
The default for width is the value of `fill-column'."
:motion evil-line
:type line
@@ -2135,7 +2135,7 @@ The default for width is the value of `fill-column'."
(evil-define-command evil-paste-before
(count &optional register yank-handler)
- "Pastes the latest yanked text before the cursor position.
+ "Paste the latest yanked text before the cursor position.
The return value is the yanked text."
:suppress-operator t
(interactive "*P<x>")
@@ -2188,7 +2188,7 @@ The return value is the yanked text."
(evil-define-command evil-paste-after
(count &optional register yank-handler)
- "Pastes the latest yanked text behind point.
+ "Paste the latest yanked text behind point.
The return value is the yanked text."
:suppress-operator t
(interactive "*P<x>")
@@ -2793,7 +2793,7 @@ next VCOUNT - 1 lines below the current one."
(when chars-to-delete (delete-char chars-to-delete))))
(evil-define-command evil-ex-show-digraphs ()
- "Shows a list of all available digraphs."
+ "Show a list of all available digraphs."
:repeat nil
(let ((columns 3))
(evil-with-view-list
@@ -3140,7 +3140,7 @@ not interfere with another."
(evil-fold-action (cdr list) action)))))
(defun evil--mode-p (modes)
- "Determines whether any symbol in MODES represents the current
+ "Determine whether any symbol in MODES represents the current
buffer's major mode or any of its minors."
(unless (eq modes '())
(let ((mode (car modes)))
@@ -3221,7 +3221,7 @@ non-nil, it is overwritten without confirmation."
(not bang))))))
(evil-define-command evil-write-all (bang)
- "Saves all buffers visiting a file.
+ "Save all buffers visiting a file.
If BANG is non nil then read-only buffers are saved, too,
otherwise they are skipped. "
:repeat nil
@@ -3266,7 +3266,7 @@ If no FILE is specified, reload the current buffer from
disk."
(revert-buffer bang (or bang (not (buffer-modified-p))) t)))
(evil-define-command evil-read (count file)
- "Inserts the contents of FILE below the current line or line COUNT."
+ "Insert the contents of FILE below the current line or line COUNT."
:repeat nil
:move-point nil
(interactive "P<fsh>")
@@ -3290,7 +3290,7 @@ If no FILE is specified, reload the current buffer from
disk."
(forward-line -1)))))
(evil-define-command evil-show-files ()
- "Shows the file-list.
+ "Show the file-list.
The same as `buffer-menu', but shows only buffers visiting
files."
:repeat nil
@@ -3311,7 +3311,7 @@ command."
(next-error 0)))
(evil-define-command evil-buffer (buffer)
- "Switches to another buffer."
+ "Switch to another buffer."
:repeat nil
(interactive "<b>")
(cond
@@ -3330,21 +3330,21 @@ command."
(switch-to-buffer buffer)))))
(evil-define-command evil-next-buffer (&optional count)
- "Goes to the `count'-th next buffer in the buffer list."
+ "Go to the `count'-th next buffer in the buffer list."
:repeat nil
(interactive "p")
(dotimes (_ (or count 1))
(next-buffer)))
(evil-define-command evil-prev-buffer (&optional count)
- "Goes to the `count'-th prev buffer in the buffer list."
+ "Go to the `count'-th prev buffer in the buffer list."
:repeat nil
(interactive "p")
(dotimes (_ (or count 1))
(previous-buffer)))
(evil-define-command evil-delete-buffer (buffer &optional bang)
- "Deletes a buffer.
+ "Delete a buffer.
All windows currently showing this buffer will be closed except
for the last window in each frame."
(interactive "<b><!>")
@@ -3372,7 +3372,7 @@ for the last window in each frame."
wins))))
(evil-define-command evil-quit (&optional force)
- "Closes the current window, current frame, current tab, Emacs.
+ "Close the current window, current frame, current tab, Emacs.
If the current frame belongs to some client the client connection
is closed."
:repeat nil
@@ -3398,7 +3398,7 @@ is closed."
(save-buffers-kill-emacs))))))))))
(evil-define-command evil-quit-all (&optional bang)
- "Exits Emacs, asking for saving."
+ "Exit Emacs, asking for saving."
:repeat nil
(interactive "<!>")
(if (null bang)
@@ -3412,7 +3412,7 @@ is closed."
(kill-emacs)))))
(evil-define-command evil-quit-all-with-error-code (&optional force)
- "Exits Emacs without saving, returning an non-zero error code.
+ "Exit Emacs without saving, returning an non-zero error code.
The FORCE argument is only there for compatibility and is ignored.
This function fails with an error if Emacs is run in server mode."
:repeat nil
@@ -3429,14 +3429,14 @@ This function fails with an error if Emacs is run in
server mode."
(save-buffers-kill-terminal t))
(evil-define-command evil-save-and-close (file &optional bang)
- "Saves the current buffer and closes the window."
+ "Save the current buffer and close the window."
:repeat nil
(interactive "<f><!>")
(evil-write nil nil nil file bang)
(evil-quit))
(evil-define-command evil-save-modified-and-close (file &optional bang)
- "Saves the current buffer and closes the window."
+ "Save the current buffer and close the window."
:repeat nil
(interactive "<f><!>")
(when (buffer-modified-p)
@@ -3514,7 +3514,7 @@ If ARG is nil this function calls `recompile', otherwise
it calls
;; TODO: escape special characters (currently only \n) ... perhaps
;; there is some Emacs function doing this?
(evil-define-command evil-show-registers (registers)
- "Shows the contents of REGISTERS, or all registers, if none supplied."
+ "Show the contents of REGISTERS, or all registers, if none supplied."
:repeat nil
(interactive "<a>")
(let* ((all-registers (evil-register-list))
@@ -3539,7 +3539,7 @@ If ARG is nil this function calls `recompile', otherwise
it calls
(t ""))])))))
(evil-define-command evil-show-marks (mrks)
- "Shows all marks.
+ "Show all marks.
If MRKS is non-nil it should be a string and only registers
corresponding to the characters of this string are shown."
:repeat nil
@@ -3636,7 +3636,7 @@ If FORCE is non-nil and MARKS is blank, all local marks
except 0-9 are removed."
(eval-when-compile (require 'ffap))
(evil-define-command evil-find-file-at-point-with-line ()
- "Opens the file at point and goes to position if present."
+ "Open the file at point and go to position if present."
(require 'ffap)
(let ((fname (with-no-warnings (ffap-file-at-point))))
(unless fname
@@ -3669,7 +3669,7 @@ If FORCE is non-nil and MARKS is blank, all local marks
except 0-9 are removed."
(user-error (format "Can't find file \"%s\" in path" region)))))
(evil-ex-define-argument-type state
- "Defines an argument type which can take state names."
+ "Define an argument type which can take state names."
:collection
(lambda (arg predicate flag)
(let ((completions
@@ -3729,13 +3729,13 @@ Change to `%s'? "
(evil-normal-state))
(evil-define-motion evil-ex-search-next (count)
- "Goes to the next occurrence."
+ "Go to the next occurrence."
:jump t
:type exclusive
(evil-ex-search count))
(evil-define-motion evil-ex-search-previous (count)
- "Goes the the previous occurrence."
+ "Go the the previous occurrence."
:jump t
:type exclusive
(let ((evil-ex-search-direction
@@ -3761,14 +3761,14 @@ resp. after executing the command."
(t (evil-repeat-motion flag))))
(evil-define-motion evil-ex-search-forward (count)
- "Starts a forward search."
+ "Start a forward search."
:jump t
:type exclusive
:repeat evil-repeat-ex-search
(evil-ex-start-search 'forward count))
(evil-define-motion evil-ex-search-backward (count)
- "Starts a forward search."
+ "Start a forward search."
:jump t
:repeat evil-repeat-ex-search
(evil-ex-start-search 'backward count))
@@ -4145,7 +4145,7 @@ Default position is the beginning of the buffer."
(message "%d" (count-lines (point-min) end)))
(evil-define-command evil-show-file-info ()
- "Shows basic file information."
+ "Show basic file information."
(let* ((nlines (count-lines (point-min) (point-max)))
(curr (line-number-at-pos (point)))
(perc (if (> nlines 0)
@@ -4255,7 +4255,7 @@ parameter\)."
"Return the last buffer WINDOW has displayed other than the
current one (equivalent to Vim's alternate buffer).
-Returns the first item in `window-prev-buffers' that isn't
+Return the first item in `window-prev-buffers' that isn't
`window-buffer' of WINDOW."
;; If the last buffer visited has been killed, then `window-prev-buffers'
;; returns a list with `current-buffer' at the head, we account for this
@@ -4275,7 +4275,7 @@ Returns the first item in `window-prev-buffers' that isn't
(goto-char (car (last previous-place))))))
(evil-define-command evil-window-delete ()
- "Deletes the current window.
+ "Delete the current window.
If `evil-auto-balance-windows' is non-nil then all children of
the deleted window's parent window are rebalanced."
(let ((p (window-parent)))
@@ -4288,7 +4288,7 @@ the deleted window's parent window are rebalanced."
(error)))))
(evil-define-command evil-window-split (&optional count file)
- "Splits the current window horizontally, COUNT lines height,
+ "Split the current window horizontally, COUNT lines height,
editing a certain FILE. The new window will be created below
when `evil-split-window-below' is non-nil. If COUNT and
`evil-auto-balance-windows' are both non-nil then all children
@@ -4304,7 +4304,7 @@ of the parent of the splitted window are rebalanced."
(evil-edit file)))
(evil-define-command evil-window-vsplit (&optional count file)
- "Splits the current window vertically, COUNT columns width,
+ "Split the current window vertically, COUNT columns width,
editing a certain FILE. The new window will be created to the
right when `evil-vsplit-window-right' is non-nil. If COUNT and
`evil-auto-balance-windows'are both non-nil then all children
@@ -4320,21 +4320,21 @@ of the parent of the splitted window are rebalanced."
(evil-edit file)))
(evil-define-command evil-split-buffer (buffer)
- "Splits window and switches to another buffer."
+ "Split window and switch to another buffer."
:repeat nil
(interactive "<b>")
(evil-window-split)
(evil-buffer buffer))
(evil-define-command evil-split-next-buffer (&optional count)
- "Splits the window and goes to the COUNT-th next buffer in the buffer list."
+ "Split the window and go to the COUNT-th next buffer in the buffer list."
:repeat nil
(interactive "p")
(evil-window-split)
(evil-next-buffer count))
(evil-define-command evil-split-prev-buffer (&optional count)
- "Splits window and goes to the COUNT-th prev buffer in the buffer list."
+ "Split window and go to the COUNT-th prev buffer in the buffer list."
:repeat nil
(interactive "p")
(evil-window-split)
@@ -4425,8 +4425,8 @@ top-left."
(other-window (1- (min count (length (window-list)))))))
(evil-define-command evil-window-new (count file)
- "Splits the current window horizontally
-and opens a new buffer or edits a certain FILE."
+ "Split the current window horizontally
+and open a new buffer or edit a certain FILE."
:repeat nil
(interactive "P<f>")
(let ((new-window (split-window (selected-window) (when count (- count))
@@ -4442,8 +4442,8 @@ and opens a new buffer or edits a certain FILE."
(evil-edit file))))
(evil-define-command evil-window-vnew (count file)
- "Splits the current window vertically
-and opens a new buffer name or edits a certain FILE."
+ "Split the current window vertically
+and open a new buffer name or edit a certain FILE."
:repeat nil
(interactive "P<f>")
(let ((new-window (split-window (selected-window) (when count (- count))
@@ -4459,7 +4459,7 @@ and opens a new buffer name or edits a certain FILE."
(evil-edit file))))
(evil-define-command evil-buffer-new (count file)
- "Creates a new buffer replacing the current window, optionally
+ "Create a new buffer replacing the current window, optionally
editing a certain FILE"
:repeat nil
(interactive "P<f>")
@@ -4495,13 +4495,13 @@ and opens a new buffer name or edits a certain FILE."
(evil-resize-window (- (window-width) count) t))
(evil-define-command evil-window-set-height (count)
- "Sets the height of the current window to COUNT."
+ "Set the height of the current window to COUNT."
:repeat nil
(interactive "<c>")
(evil-resize-window (or count (frame-height)) nil))
(evil-define-command evil-window-set-width (count)
- "Sets the width of the current window to COUNT."
+ "Set the width of the current window to COUNT."
:repeat nil
(interactive "<c>")
(evil-resize-window (or count (frame-width)) t))
@@ -4530,7 +4530,7 @@ If ARG is empty, maximize the current window height."
(evil-window-decrease-height (- n))))))
(evil-define-command evil-window-rotate-upwards ()
- "Rotates the windows according to the current cyclic ordering."
+ "Rotate the windows according to the current cyclic ordering."
:repeat nil
(evil-save-side-windows
(let ((wlist (window-list))
@@ -4543,7 +4543,7 @@ If ARG is empty, maximize the current window height."
(select-window (car (last (window-list)))))))
(evil-define-command evil-window-rotate-downwards ()
- "Rotates the windows according to the current cyclic ordering."
+ "Rotate the windows according to the current cyclic ordering."
:repeat nil
(evil-save-side-windows
(let ((wlist (window-list))
@@ -4574,26 +4574,26 @@ With COUNT: Exchange current window with COUNTth
window."
(switch-to-buffer this-buffer nil t)))
(evil-define-command evil-window-move-very-top ()
- "Closes the current window, splits the upper-left one horizontally
-and redisplays the current buffer there."
+ "Close the current window, split the upper-left one horizontally
+and redisplay the current buffer there."
:repeat nil
(evil-move-window 'above))
(evil-define-command evil-window-move-far-left ()
- "Closes the current window, splits the upper-left one vertically
-and redisplays the current buffer there."
+ "Close the current window, split the upper-left one vertically
+and redisplay the current buffer there."
:repeat nil
(evil-move-window 'left))
(evil-define-command evil-window-move-far-right ()
- "Closes the current window, splits the lower-right one vertically
-and redisplays the current buffer there."
+ "Close the current window, split the lower-right one vertically
+and redisplay the current buffer there."
:repeat nil
(evil-move-window 'right))
(evil-define-command evil-window-move-very-bottom ()
- "Closes the current window, splits the lower-right one horizontally
-and redisplays the current buffer there."
+ "Close the current window, split the lower-right one horizontally
+and redisplay the current buffer there."
:repeat nil
(evil-move-window 'below))
diff --git a/evil-common.el b/evil-common.el
index 2513560577..42290c1476 100644
--- a/evil-common.el
+++ b/evil-common.el
@@ -314,7 +314,7 @@ sorting in between."
vars))))))
(defun evil-vector-to-string (vector)
- "Turns vector into a string, changing <escape> to '\\e'"
+ "Turn vector into a string, changing <escape> to '\\e'"
(mapconcat (lambda (c)
(if (equal c 'escape)
"\e"
@@ -481,7 +481,7 @@ keystrokes."
(defun evil-delimited-arguments (string &optional num)
"Parse STRING as a sequence of delimited arguments.
-Returns a list of NUM strings, or as many arguments as
+Return a list of NUM strings, or as many arguments as
the string contains. The first non-blank character is
taken to be the delimiter. If some arguments are missing
from STRING, the resulting list is padded with nil values.
@@ -536,7 +536,7 @@ If any character set is complemented, the result is also
complemented."
(defun evil-keypress-parser (&optional input)
"Read from keyboard or INPUT and build a command description.
-Returns (CMD COUNT), where COUNT is the numeric prefix argument.
+Return (CMD COUNT), where COUNT is the numeric prefix argument.
Both COUNT and CMD may be nil."
(let (count negative)
(when input (setq unread-command-events (append input
unread-command-events)))
@@ -695,7 +695,7 @@ Return a list (MOTION COUNT [TYPE])."
(list motion count type)))
(defun evil-mouse-events-p (keys)
- "Returns non-nil iff KEYS contains a mouse event."
+ "Return non-nil iff KEYS contains a mouse event."
(catch 'done
(dotimes (i (length keys))
(when (or (and (fboundp 'mouse-event-p)
@@ -705,8 +705,8 @@ Return a list (MOTION COUNT [TYPE])."
nil))
(defun evil-extract-count (keys)
- "Splits the key-sequence KEYS into prefix-argument and the rest.
-Returns the list (PREFIX CMD SEQ REST), where PREFIX is the
+ "Split the key-sequence KEYS into prefix-argument and the rest.
+Return the list (PREFIX CMD SEQ REST), where PREFIX is the
prefix count, CMD the command to be executed, SEQ the subsequence
calling CMD, and REST is all remaining events in the
key-sequence. PREFIX and REST may be nil if they do not exist.
@@ -768,7 +768,7 @@ filename."
(setcdr map (cons prompt (cdr map)))))
(defun evil-lookup-key (map key)
- "Returns non-nil value if KEY is bound in MAP."
+ "Return non-nil value if KEY is bound in MAP."
(let ((definition (lookup-key map key)))
(if (numberp definition) ; in-band error
nil
@@ -951,7 +951,7 @@ If POS is a marker, return its position."
pos)))
(defmacro evil-save-goal-column (&rest body)
- "Restores the goal column after execution of BODY.
+ "Restore the goal column after execution of BODY.
See also `evil-save-column'."
(declare (indent defun)
(debug t))
@@ -960,7 +960,7 @@ See also `evil-save-column'."
,@body))
(defmacro evil-save-column (&rest body)
- "Restores the column after execution of BODY.
+ "Restore the column after execution of BODY.
See also `evil-save-goal-column'."
(declare (indent defun)
(debug t))
@@ -1191,7 +1191,7 @@ the loop immediately quits. See also `evil-loop'.
(throw ',done ,i))))))))
(defmacro evil-signal-without-movement (&rest body)
- "Catches errors provided point moves within this scope."
+ "Catch errors provided point moves within this scope."
(declare (indent defun)
(debug t))
`(let ((p (point)))
@@ -1202,7 +1202,7 @@ the loop immediately quits. See also `evil-loop'.
(signal (car err) (cdr err)))))))
(defun evil-signal-at-bob-or-eob (&optional count)
- "Signals error if `point' is at boundaries.
+ "Signal error if `point' is at boundaries.
If `point' is at bob and COUNT is negative this function signal
'beginning-of-buffer. If `point' is at eob and COUNT is positive
this function singal 'end-of-buffer. This function should be used
@@ -1213,14 +1213,14 @@ in motions. COUNT defaults to 1."
((> count 0) (evil-signal-at-eob))))
(defun evil-signal-at-bob ()
- "Signals 'beginning-of-buffer if `point' is at bob.
+ "Signal 'beginning-of-buffer if `point' is at bob.
This function should be used in backward motions. If `point' is at
bob so that no further backward motion is possible the error
'beginning-of-buffer is raised."
(when (bobp) (signal 'beginning-of-buffer nil)))
(defun evil-signal-at-eob ()
- "Signals 'end-of-buffer if `point' is at eob.
+ "Signal 'end-of-buffer if `point' is at eob.
This function should be used in forward motions. If `point' is close
to eob so that no further forward motion is possible the error
'end-of-buffer is raised. This is the case if `point' is at
@@ -1308,7 +1308,7 @@ See also `evil-goto-min'."
(point-min))))))))
(defun evil-bounds-of-not-thing-at-point (thing &optional which)
- "Returns the bounds of a complement of THING at point.
+ "Return the bounds of a complement of THING at point.
If there is a THING at point nil is returned. Otherwise if WHICH
is nil or 0 a cons cell (BEG . END) is returned. If WHICH is
negative the beginning is returned. If WHICH is positive the END
@@ -1329,7 +1329,7 @@ is returned."
((> which 0) end))))))
(defun evil-forward-nearest (count &rest forwards)
- "Moves point forward to the first of several motions.
+ "Move point forward to the first of several motions.
FORWARDS is a list of forward motion functions (i.e. each moves
point forward to the next end of a text object (if passed a +1)
or backward to the preceeding beginning of a text object (if
@@ -1899,7 +1899,7 @@ moved."
count))
(defun evil-in-comment-p (&optional pos)
- "Checks if POS is within a comment according to current syntax.
+ "Check if POS is within a comment according to current syntax.
If POS is nil, (point) is used. The return value is the beginning
position of the comment."
(setq pos (or pos (point)))
@@ -1922,9 +1922,9 @@ position of the comment."
(and (nth 4 syn) (nth 8 syn)))))
(defun evil-looking-at-start-comment (&optional move)
- "Returns t if point is at the start of a comment.
-point must be on one of the opening characters of a block comment
-according to the current syntax table. Futhermore these
+ "Return t if point is at the start of a comment.
+Point must be on one of the opening characters of a block comment
+according to the current syntax table. Futhermore, these
characters must been parsed as opening characters, i.e. they
won't be considered as comment starters inside a string or
possibly another comment. Point is moved to the first character
@@ -1948,9 +1948,9 @@ of the comment opener if MOVE is non-nil."
(prog1 t (when move (backward-char)))))))
(defun evil-looking-at-end-comment (&optional move)
- "Returns t if point is at the end of a comment.
-point must be on one of the opening characters of a block comment
-according to the current syntax table. Futhermore these
+ "Return t if point is at the end of a comment.
+Point must be on one of the opening characters of a block comment
+according to the current syntax table. Futhermore, these
characters must been parsed as opening characters, i.e. they
won't be considered as comment starters inside a string or
possibly another comment. Point is moved right after the comment
@@ -1979,7 +1979,7 @@ closer if MOVE is non-nil."
(prog1 t (when move (forward-char)))))))
(defun evil-insert-newline-above ()
- "Inserts a new line above point and places point in that line
+ "Insert a new line above point and place point in that line
with regard to indentation."
(evil-narrow-to-field
(evil-move-beginning-of-line)
@@ -1988,7 +1988,7 @@ with regard to indentation."
(back-to-indentation)))
(defun evil-insert-newline-below ()
- "Inserts a new line below point and places point in that line
+ "Insert a new line below point and place point in that line
with regard to indentation."
(evil-narrow-to-field
(evil-move-end-of-line)
@@ -2303,7 +2303,7 @@ register instead of replacing its content."
(set-register register text))))
(defun evil-register-list ()
- "Returns an alist of all registers, but only those named
+ "Return an alist of all registers, but only those named
with number or character. Registers with symbol or string in names are ignored
to keep Vim compatibility with register jumps."
(sort (append (mapcar #'(lambda (reg)
@@ -2316,7 +2316,7 @@ to keep Vim compatibility with register jumps."
#'(lambda (reg1 reg2) (< (car reg1) (car reg2)))))
(defsubst evil-kbd-macro-suppress-motion-error ()
- "Returns non-nil if a motion error should be suppressed.
+ "Return non-nil if a motion error should be suppressed.
Whether the motion error should be suppressed depends on the
variable `evil-kbd-macro-suppress-motion-error'."
(or (and defining-kbd-macro
@@ -2592,7 +2592,7 @@ The tracked insertion is set to `evil-last-insertion'."
;;; Paste
(defun evil-yank-characters (beg end &optional register yank-handler)
- "Saves the characters defined by the region BEG and END in the kill-ring."
+ "Save the characters defined by the region BEG and END in the kill-ring."
(let ((text (filter-buffer-substring beg end)))
(when yank-handler
(setq text (propertize text 'yank-handler (list yank-handler))))
@@ -2604,7 +2604,7 @@ The tracked insertion is set to `evil-last-insertion'."
(kill-new text))))
(defun evil-yank-lines (beg end &optional register yank-handler)
- "Saves the lines in the region BEG and END into the kill-ring."
+ "Save the lines in the region BEG and END into the kill-ring."
(let* ((text (filter-buffer-substring beg end))
(yank-handler (list (or yank-handler
#'evil-yank-line-handler)
@@ -2624,7 +2624,7 @@ The tracked insertion is set to `evil-last-insertion'."
(kill-new text))))
(defun evil-yank-rectangle (beg end &optional register yank-handler)
- "Saves the rectangle defined by region BEG and END into the kill-ring."
+ "Save the rectangle defined by region BEG and END into the kill-ring."
(let ((lines (list nil)))
(evil-apply-on-rectangle #'extract-rectangle-line beg end lines)
;; We remove spaces from the beginning and the end of the next.
@@ -2649,14 +2649,14 @@ The tracked insertion is set to `evil-last-insertion'."
text)))
(defun evil-remove-yank-excluded-properties (text)
- "Removes `yank-excluded-properties' from TEXT."
+ "Remove `yank-excluded-properties' from TEXT."
(if (eq yank-excluded-properties t)
(set-text-properties 0 (length text) nil text)
(remove-list-of-text-properties 0 (length text)
yank-excluded-properties text)))
(defun evil-yank-line-handler (text)
- "Inserts the current text linewise."
+ "Insert the current text linewise."
(let ((text (apply #'concat (make-list (or evil-paste-count 1) text)))
(opoint (point)))
(evil-remove-yank-excluded-properties text)
@@ -2696,7 +2696,7 @@ The tracked insertion is set to `evil-last-insertion'."
(insert text)))))
(defun evil-yank-block-handler (lines)
- "Inserts the current text as block."
+ "Insert the current text as block."
(let ((count (or evil-paste-count 1))
(col (if (eq this-command 'evil-paste-after)
(1+ (current-column))
@@ -2819,7 +2819,7 @@ is negative this is a more recent kill."
(defun evil-match-interactive-code (interactive &optional pos)
"Match an interactive code at position POS in string INTERACTIVE.
-Returns the first matching entry in `evil-interactive-alist', or nil."
+Return the first matching entry in `evil-interactive-alist', or nil."
(let ((length (length interactive))
(pos (or pos 0)))
(catch 'done
@@ -2833,7 +2833,7 @@ Returns the first matching entry in
`evil-interactive-alist', or nil."
(defun evil-concatenate-interactive-forms (&rest forms)
"Concatenate interactive list expressions FORMS.
-Returns a single expression where successive expressions
+Return a single expression where successive expressions
are joined, if possible."
(let (result)
(when forms
@@ -2952,7 +2952,7 @@ will make `line' the type of the `next-line' command."
(defun evil-expand (beg end type &rest properties)
"Expand BEG and END as TYPE with PROPERTIES.
-Returns a list (BEG END TYPE PROPERTIES ...), where the tail
+Return a list (BEG END TYPE PROPERTIES ...), where the tail
may contain a property list."
(apply #'evil-transform
;; don't expand if already expanded
@@ -2961,19 +2961,19 @@ may contain a property list."
(defun evil-contract (beg end type &rest properties)
"Contract BEG and END as TYPE with PROPERTIES.
-Returns a list (BEG END TYPE PROPERTIES ...), where the tail
+Return a list (BEG END TYPE PROPERTIES ...), where the tail
may contain a property list."
(apply #'evil-transform :contract beg end type properties))
(defun evil-normalize (beg end type &rest properties)
"Normalize BEG and END as TYPE with PROPERTIES.
-Returns a list (BEG END TYPE PROPERTIES ...), where the tail
+Return a list (BEG END TYPE PROPERTIES ...), where the tail
may contain a property list."
(apply #'evil-transform :normalize beg end type properties))
(defun evil-transform (transform beg end type &rest properties)
"Apply TRANSFORM on BEG and END with PROPERTIES.
-Returns a list (BEG END TYPE PROPERTIES ...), where the tail
+Return a list (BEG END TYPE PROPERTIES ...), where the tail
may contain a property list. If TRANSFORM is undefined,
return positions unchanged."
(let* ((type (or type (evil-type properties)))
@@ -3730,7 +3730,7 @@ in `evil-temporary-undo' instead."
regexp nil t))
(defun evil-transform-magic (str magic quote transform &optional _start)
- "Transforms STR with magic characters.
+ "Transform STR with magic characters.
MAGIC is a regexp that matches all potential magic
characters. Each occurence of CHAR as magic character within str
is replaced by the result of calling the associated TRANSFORM
@@ -3848,7 +3848,7 @@ transformations, usually `regexp-quote' or
`replace-quote'."
(defconst evil-regexp-magic "[][(){}<>_dDsSxXoOaAlLuUwWyY.*+?=^$`|nrtb]")
(defun evil-transform-vim-style-regexp (regexp)
- "Transforms vim-style backslash codes to Emacs regexp.
+ "Transform vim-style backslash codes to Emacs regexp.
This includes the backslash codes \\d, \\D, \\s, \\S, \\x, \\X,
\\o, \\O, \\a, \\A, \\l, \\L, \\u, \\U and \\w, \\W. The new
codes \\y and \\Y can be used instead of the Emacs code \\s and
@@ -3880,7 +3880,7 @@ codes \\y and \\Y can be used instead of the Emacs code
\\s and
(substring str 1))))
(defun evil-get-magic (magic)
- "Returns a regexp matching the magic characters according to MAGIC.
+ "Return a regexp matching the magic characters according to MAGIC.
Depending on the value of MAGIC the following characters are
considered magic.
t [][{}*+?.&~$^
@@ -3899,7 +3899,7 @@ considered magic.
(defun evil-compile-subreplacement (to &optional start)
"Convert a regexp replacement TO to Lisp from START until \\e or \\E.
-Returns a pair (RESULT . REST). RESULT is a list suitable for
+Return a pair (RESULT . REST). RESULT is a list suitable for
`perform-replace' if necessary, the original string if not.
REST is the unparsed remainder of TO."
(let ((result
@@ -3966,7 +3966,7 @@ REST is the unparsed remainder of TO."
(defun evil-compile-replacement (to)
"Maybe convert a regexp replacement TO to Lisp.
-Returns a list suitable for `perform-replace' if necessary, the
+Return a list suitable for `perform-replace' if necessary, the
original string if not. Currently the following magic characters
in replacements are supported: 0-9&#lLuUrnbt,
The magic character , (comma) start an Emacs-lisp expression."
@@ -3999,7 +3999,7 @@ the replacement text, otherwise the function behaves as
;;; Alignment
(defun evil-justify-lines (beg end justify position)
- "Justifes all lines in a range.
+ "Justify all lines in a range.
BEG and END specify the range of those lines to be
justified. JUSTIFY is either 'left, 'right or 'center according
to the justification type. POSITION is the maximal text width for
@@ -4056,7 +4056,7 @@ should be left-aligned for left justification."
(define-key evil-list-view-mode-map [return] #'evil-list-view-goto-entry)
(defmacro evil-with-view-list (&rest properties)
- "Opens new list view buffer.
+ "Open new list view buffer.
PROPERTIES is a property-list which supports the following properties:
diff --git a/evil-core.el b/evil-core.el
index d2ab7f30b2..1e33825253 100644
--- a/evil-core.el
+++ b/evil-core.el
@@ -290,7 +290,7 @@ See also `evil-initial-state'."
(defun evil-initial-state (mode &optional default follow-parent checked-modes)
"Return the Evil state to use for MODE or its alias.
-Returns DEFAULT if no initial state is associated with MODE.
+Return DEFAULT if no initial state is associated with MODE.
The initial state for a mode can be set with
`evil-set-initial-state'.
@@ -781,7 +781,7 @@ This is a keymap alist, determined by the current state
(defun evil-mode-for-keymap (keymap &optional default)
"Return the minor mode associated with KEYMAP.
-Returns DEFAULT if no mode is found.
+Return DEFAULT if no mode is found.
See also `evil-keymap-for-mode'."
(let ((map (if (keymapp keymap) keymap (symbol-value keymap)))
(var (when (symbolp keymap) keymap)))
diff --git a/evil-ex.el b/evil-ex.el
index 89b4aa63d9..083fbdbe23 100644
--- a/evil-ex.el
+++ b/evil-ex.el
@@ -375,7 +375,7 @@ in case of incomplete or unknown commands."
(remove-hook 'pre-command-hook 'evil--ex-remove-echo-overlay t))
(defun evil-ex-completion ()
- "Completes the current ex command or argument."
+ "Complete the current ex command or argument."
(interactive)
(let (after-change-functions)
(evil-ex-update)
@@ -492,7 +492,7 @@ in case of incomplete or unknown commands."
(funcall (cdr completer)))))))))
(defun evil-ex-define-cmd (cmd function)
- "Binds the function FUNCTION to the command CMD."
+ "Bind the function FUNCTION to the command CMD."
(save-match-data
(if (string-match "^[^][]*\\(\\[\\(.*\\)\\]\\)[^][]*$" cmd)
(let ((abbrev (replace-match "" nil t cmd 1))
@@ -511,7 +511,7 @@ in case of incomplete or unknown commands."
(cadr arg-handler))
(defmacro evil-ex-define-argument-type (arg-type doc &rest body)
- "Defines a new handler for argument-type ARG-TYPE.
+ "Define a new handler for argument-type ARG-TYPE.
DOC is the documentation string. It is followed by a list of
keywords and function:
@@ -564,7 +564,7 @@ keywords and function:
'(,runner ,completer)))))
(evil-ex-define-argument-type file
- "Handles a file argument."
+ "Handle a file argument."
:collection read-file-name-internal)
(evil-ex-define-argument-type buffer
@@ -574,7 +574,7 @@ keywords and function:
(declare-function shell-completion-vars "shell" ())
(defun evil-ex-init-shell-argument-completion (flag &optional arg)
- "Prepares the current minibuffer for completion of shell commands.
+ "Prepare the current minibuffer for completion of shell commands.
This function must be called from the :runner function of some
argument handler that requires shell completion."
(when (and (eq flag 'start)
@@ -617,7 +617,7 @@ works accordingly."
:runner evil-ex-init-shell-argument-completion)
(defun evil-ex-binding (command &optional noerror)
- "Returns the final binding of COMMAND."
+ "Return the final binding of COMMAND."
(let ((binding (save-match-data
(string-match "^\\(.+?\\)\\!?$" command)
(match-string 1 command))))
@@ -633,7 +633,7 @@ works accordingly."
(user-error "Unknown command: `%s'" command)))))
(defun evil-ex-completed-binding (command &optional noerror)
- "Returns the final binding of the completion of COMMAND."
+ "Return the final binding of the completion of COMMAND."
(let ((completion (try-completion command evil-ex-commands)))
(evil-ex-binding (if (eq completion t) command
(or completion command))
@@ -670,13 +670,13 @@ Replaces # by the alternate file-name in FILE-NAME."
file-name)
(defun evil-ex-file-arg ()
- "Returns the current Ex argument as a file name.
+ "Return the current Ex argument as a file name.
This function interprets special file names like # and %."
(unless (zerop (length evil-ex-argument))
(evil-ex-replace-special-filenames evil-ex-argument)))
(defun evil-ex-repeat (count)
- "Repeats the last ex command."
+ "Repeat the last ex command."
(interactive "P")
(when count
(goto-char (point-min))
@@ -771,7 +771,7 @@ This function interprets special file names like # and %."
(line-number-at-pos)))
(defun evil-ex-range (beg-line &optional end-line)
- "Returns the first and last position of the current range."
+ "Return the first and last position of the current range."
(when (and end-line (< end-line beg-line))
(setq evil-ex-reverse-range t)
(let ((beg-line* beg-line))
@@ -816,7 +816,7 @@ Signal an error if MARKER is in a different buffer."
(defun evil-ex-re-fwd (pattern)
"Search forward for PATTERN.
-Returns the line number of the match."
+Return the line number of the match."
(when evil-ex-search-vim-style-regexp
(setq pattern (evil-transform-vim-style-regexp pattern)))
(setq evil-ex-search-pattern (evil-ex-make-search-pattern pattern)
@@ -837,7 +837,7 @@ Returns the line number of the match."
(defun evil-ex-re-bwd (pattern)
"Search backward for PATTERN.
-Returns the line number of the match."
+Return the line number of the match."
(when evil-ex-search-vim-style-regexp
(setq pattern (evil-transform-vim-style-regexp pattern)))
(setq evil-ex-search-pattern (evil-ex-make-search-pattern pattern)
diff --git a/evil-jumps.el b/evil-jumps.el
index fea2e431df..de10b8da85 100644
--- a/evil-jumps.el
+++ b/evil-jumps.el
@@ -123,7 +123,7 @@
(remove-hook 'savehist-mode-hook #'evil--jumps-savehist-load))
(defun evil--jumps-savehist-sync ()
- "Updates the printable value of window jumps for `savehist'."
+ "Update the printable value of window jumps for `savehist'."
(setq evil-jumps-history
(delq nil (mapcar #'(lambda (jump)
(let* ((mark (car jump))
@@ -166,7 +166,7 @@
(run-hooks 'evil-jumps-post-jump-hook))))))
(defun evil--jumps-push ()
- "Pushes the current cursor/file position to the jump list."
+ "Push the current cursor/file position to the jump list."
(let ((target-list (evil--jumps-get-window-jump-list)))
(let ((file-name (buffer-file-name))
(buffer-name (buffer-name))
diff --git a/evil-repeat.el b/evil-repeat.el
index 1234c1ca6d..73cd2da307 100644
--- a/evil-repeat.el
+++ b/evil-repeat.el
@@ -144,7 +144,7 @@
(evil-repeat-abort)))
(defsubst evil-repeat-recording-p ()
- "Returns non-nil iff a recording is in progress."
+ "Return non-nil iff a recording is in progress."
(eq evil-recording-repeat t))
(defun evil-repeat-start ()
@@ -240,7 +240,7 @@ If COMMAND doesn't have this property, return DEFAULT."
(if repeat-type (cdr repeat-type) type))))
(defun evil-repeat-force-abort-p (repeat-type)
- "Returns non-nil iff the current command should abort the recording of
repeat information."
+ "Return non-nil iff the current command should abort the recording of repeat
information."
(or (evil-repeat-different-buffer-p) ; ... buffer changed
(eq repeat-type 'abort) ; ... explicitely forced
(eq evil-recording-repeat 'abort) ; ... already aborted
@@ -388,12 +388,12 @@ If CHANGE is specified, it is added to
`evil-repeat-changes'."
(nconc evil-repeat-changes (list (list relpos ins ndel))))))
(defun evil-repeat-start-record-changes ()
- "Starts the recording of a new set of buffer changes."
+ "Start the recording of a new set of buffer changes."
(setq evil-repeat-changes nil)
(evil-repeat-record-position))
(defun evil-repeat-finish-record-changes ()
- "Finishes the recording of buffer changes and records them as repeat."
+ "Finish the recording of buffer changes and record them as repeat."
(when (evil-repeat-recording-p)
(evil-repeat-record `(evil-execute-change
,evil-repeat-changes
@@ -423,7 +423,7 @@ inserts some text in a buffer between (point) and (mark)."
(defun evil-normalize-repeat-info (repeat-info)
"Concatenate consecutive arrays in REPEAT-INFO.
-Returns a single array."
+Return a single array."
(let* ((result (cons nil nil))
(result-last result)
cur cur-last)
@@ -451,7 +451,7 @@ Returns a single array."
(cdr result)))
(defun evil-repeat-visual-char (nfwdlines nfwdchars)
- "Restores a character visual selection.
+ "Restore a character visual selection.
If the selection is in a single line, the restored visual
selection covers the same number of characters. If the selection
covers several lines, the restored selection covers the same
@@ -463,7 +463,7 @@ line as the original selection."
(forward-char nfwdchars))
(defun evil-repeat-visual-line (nfwdlines)
- "Restores a character visual selection.
+ "Restore a character visual selection.
If the selection is in a single line, the restored visual
selection covers the same number of characters. If the selection
covers several lines, the restored selection covers the same
@@ -473,7 +473,7 @@ line as the original selection."
(forward-line nfwdlines))
(defun evil-repeat-visual-block (nfwdlines nfwdchars)
- "Restores a character visual selection.
+ "Restore a character visual selection.
If the selection is in a single line, the restored visual
selection covers the same number of characters. If the selection
covers several lines, the restored selection covers the same
@@ -485,7 +485,7 @@ line as the original selection."
(move-to-column (+ col nfwdchars) t)))
(defun evil-execute-change (changes rel-point)
- "Executes as list of changes.
+ "Execute as list of changes.
CHANGES is a list of triples (REL-BEG INSERT-TEXT NDEL).
REL-BEG is the relative position (to point) where the change
@@ -504,7 +504,7 @@ where point should be placed after all changes."
(goto-char (+ point rel-point)))))
(defun evil-execute-repeat-info (repeat-info)
- "Executes a repeat-information REPEAT-INFO."
+ "Execute a repeat-information REPEAT-INFO."
(evil-save-repeat-info
(dolist (rep repeat-info)
(cond
diff --git a/evil-search.el b/evil-search.el
index b57ad7bb43..ae8f2a4dfb 100644
--- a/evil-search.el
+++ b/evil-search.el
@@ -397,7 +397,7 @@ letter, otherwise it will be case-insensitive."
;; a pattern
(defun evil-ex-make-substitute-pattern (regexp flags)
- "Creates a PATTERN for substitution with FLAGS.
+ "Create a PATTERN for substitution with FLAGS.
This function respects the values of `evil-ex-substitute-case'
and `evil-ex-substitute-global'."
(evil-ex-make-pattern regexp
@@ -413,7 +413,7 @@ and `evil-ex-substitute-global'."
(memq ?g flags)))))
(defun evil-ex-make-search-pattern (regexp)
- "Creates a PATTERN for search.
+ "Create a PATTERN for search.
This function respects the values of `evil-ex-search-case'."
(evil-ex-make-pattern regexp evil-ex-search-case t))
@@ -743,7 +743,7 @@ Note that this function ignores the whole-line property of
PATTERN."
(user-error "Unknown search direction: %s" direction)))))
(defun evil-ex-hl-idle-update ()
- "Triggers the timer to update the highlights in the current buffer."
+ "Trigger the timer to update the highlights in the current buffer."
(when (and evil-ex-interactive-search-highlight
evil-ex-active-highlights-alist)
(when evil-ex-hl-update-timer
@@ -924,7 +924,7 @@ message to be shown. This function does nothing if
(defun evil-ex-split-search-pattern (pattern direction)
"Split PATTERN in regexp, offset and next-pattern parts.
-Returns a triple (regexp offset next-search)."
+Return a triple (regexp offset next-search)."
(save-match-data
(if (or (and (eq direction 'forward)
(string-match
"\\(?:^\\|[^\\\\]\\)\\(?:\\\\\\\\\\)*\\(/\\([^;]*\\)\\(?:;\\([/?].*\\)?\\)?\\)?$"
@@ -1267,7 +1267,7 @@ This handler highlights the pattern of the current
substitution."
(list pattern command)))
(defun evil-ex-get-substitute-info (string &optional implicit-r)
- "Returns the substitution info of command line STRING.
+ "Return the substitution info of command line STRING.
This function returns a three-element list \(PATTERN REPLACEMENT
FLAGS) consisting of the substitution parts of STRING. PATTERN is
a ex-pattern (see `evil-ex-make-pattern') and REPLACEMENT in a
diff --git a/evil-types.el b/evil-types.el
index a230b3cfa8..d457158208 100644
--- a/evil-types.el
+++ b/evil-types.el
@@ -417,7 +417,7 @@ REGISTER"
(defun evil-ex-get-optional-register-and-count (string)
"Parse STRING as an ex arg with both optional REGISTER and COUNT.
-Returns a list (REGISTER COUNT)."
+Return a list (REGISTER COUNT)."
(let* ((split-args (split-string (or string "")))
(arg-count (length split-args))
(arg0 (car split-args))
diff --git a/evil-vars.el b/evil-vars.el
index 6dbb1bc068..8bd4011767 100644
--- a/evil-vars.el
+++ b/evil-vars.el
@@ -63,7 +63,7 @@ the :initialize property of `defcustom'.")
evil-pending-custom-initialize))
(defun evil-run-pending-custom-initialize ()
- "Executes the pending initializations.
+ "Execute the pending initializations.
See `evil-pending-custom-initialize'."
(dolist (init evil-pending-custom-initialize)
(apply (car init) (cdr init)))
@@ -92,7 +92,7 @@ KEY must be readable by `read-kbd-macro'."
(define-key map old-key nil))))))))
(defun evil-set-custom-state-maps (var pending-var key _make newlist)
- "Changes the list of special keymaps.
+ "Change the list of special keymaps.
VAR is the variable containing the list of keymaps.
PENDING-VAR is the variable containing the list of the currently pending
keymaps.
@@ -109,7 +109,7 @@ NEWLIST the list of new special keymaps."
(evil-update-pending-maps))
(defun evil-update-pending-maps (&optional _file)
- "Tries to set pending special keymaps.
+ "Try to set pending special keymaps.
This function should be called from an `after-load-functions'
hook."
(let ((maps '((evil-make-overriding-map . evil-pending-overriding-maps)
@@ -144,7 +144,7 @@ commands."
(evil-set-command-property cmd :exclude-newline t))))
(defun evil-set-custom-motions (var values)
- "Sets the list of motion commands."
+ "Set the list of motion commands."
(with-no-warnings
(when (default-boundp var)
(dolist (motion (default-value var))
@@ -1358,9 +1358,9 @@ SYMBOL is made permanent buffer local."
(put ',symbol 'permanent-local t)))
(evil-define-local-var evil-scroll-count 0
- "Holds last used prefix for `evil-scroll-up'
+ "Hold last used prefix for `evil-scroll-up'
and `evil-scroll-down'.
-Determines how many lines should be scrolled.
+Determine how many lines should be scrolled.
Default value is 0 - scroll half the screen.")
(evil-define-local-var evil-state nil
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [nongnu] elpa/evil 0aaf5944db: doc: follow the Emacs Lisp Style Guide,
ELPA Syncer <=