summaryrefslogtreecommitdiff
path: root/lisp/eshell
diff options
context:
space:
mode:
authorStefan Kangas <stefan@marxist.se>2021-09-14 07:55:56 +0200
committerStefan Kangas <stefan@marxist.se>2021-09-14 07:57:14 +0200
commit25ebb9374bdadf66153727831fc7ff131c8cf299 (patch)
tree7ed04a5efe70f4f6e66118aebd9ccee12275d6bf /lisp/eshell
parentcf2fa6c87f4da4665ff8a9e8e220bba0b5bccefc (diff)
downloademacs-25ebb9374bdadf66153727831fc7ff131c8cf299.tar.gz
emacs-25ebb9374bdadf66153727831fc7ff131c8cf299.tar.bz2
emacs-25ebb9374bdadf66153727831fc7ff131c8cf299.zip
; More minor docfixes found by checkdoc
Diffstat (limited to 'lisp/eshell')
-rw-r--r--lisp/eshell/em-basic.el2
-rw-r--r--lisp/eshell/em-glob.el4
-rw-r--r--lisp/eshell/em-hist.el2
-rw-r--r--lisp/eshell/em-ls.el14
-rw-r--r--lisp/eshell/em-pred.el2
-rw-r--r--lisp/eshell/em-rebind.el2
-rw-r--r--lisp/eshell/em-smart.el4
-rw-r--r--lisp/eshell/esh-arg.el2
-rw-r--r--lisp/eshell/esh-cmd.el4
-rw-r--r--lisp/eshell/esh-ext.el2
-rw-r--r--lisp/eshell/esh-io.el2
-rw-r--r--lisp/eshell/esh-mode.el2
-rw-r--r--lisp/eshell/eshell.el10
13 files changed, 26 insertions, 26 deletions
diff --git a/lisp/eshell/em-basic.el b/lisp/eshell/em-basic.el
index 64fc7e7f03b..af5550b11df 100644
--- a/lisp/eshell/em-basic.el
+++ b/lisp/eshell/em-basic.el
@@ -164,7 +164,7 @@ or `eshell-printn' for display."
(set-default-file-modes
(- 511 (car (read-from-string
(concat "?\\" (number-to-string (car args)))))))
- (error "setting umask symbolically is not yet implemented"))
+ (error "Setting umask symbolically is not yet implemented"))
(eshell-print
"Warning: umask changed for all new files created by Emacs.\n"))
nil))
diff --git a/lisp/eshell/em-glob.el b/lisp/eshell/em-glob.el
index e36f2d0c7fe..ba12e43a3c2 100644
--- a/lisp/eshell/em-glob.el
+++ b/lisp/eshell/em-glob.el
@@ -91,7 +91,7 @@ This option slows down recursive glob processing by quite a bit."
(defcustom eshell-error-if-no-glob nil
"If non-nil, it is an error for a glob pattern not to match.
- This mimics the behavior of zsh if non-nil, but bash if nil."
+This mimics the behavior of zsh if non-nil, but bash if nil."
:type 'boolean
:group 'eshell-glob)
@@ -266,7 +266,7 @@ the form:
;; FIXME does this really need to abuse eshell-glob-matches, message-shown?
(defun eshell-glob-entries (path globs &optional recurse-p)
- "Glob the entries in PATHS, possibly recursing if RECURSE-P is non-nil."
+ "Glob the entries in PATH, possibly recursing if RECURSE-P is non-nil."
(let* ((entries (ignore-errors
(file-name-all-completions "" path)))
(case-fold-search eshell-glob-case-insensitive)
diff --git a/lisp/eshell/em-hist.el b/lisp/eshell/em-hist.el
index d82946add00..aa158fa24cc 100644
--- a/lisp/eshell/em-hist.el
+++ b/lisp/eshell/em-hist.el
@@ -402,7 +402,7 @@ variable `eshell-input-filter' returns non-nil when called on the
command.
This function is supposed to be called from the minibuffer, presumably
-as a minibuffer-exit-hook."
+as a `minibuffer-exit-hook'."
(eshell-add-input-to-history
(buffer-substring (minibuffer-prompt-end) (point-max))))
diff --git a/lisp/eshell/em-ls.el b/lisp/eshell/em-ls.el
index 3d7c43b404b..57146bb126d 100644
--- a/lisp/eshell/em-ls.el
+++ b/lisp/eshell/em-ls.el
@@ -35,10 +35,10 @@
;;;###autoload
(progn
(defgroup eshell-ls nil
- "This module implements the \"ls\" utility fully in Lisp. If it is
-passed any unrecognized command switches, it will revert to the
-operating system's version. This version of \"ls\" uses text
-properties to colorize its output based on the setting of
+ "This module implements the \"ls\" utility fully in Lisp.
+If it is passed any unrecognized command switches, it will revert
+to the operating system's version. This version of \"ls\" uses
+text properties to colorize its output based on the setting of
`eshell-ls-use-colors'."
:tag "Implementation of `ls' in Lisp"
:group 'eshell-module))
@@ -476,9 +476,9 @@ name should be displayed as, etc. Think of it as cooking a FILEINFO."
fileinfo)
(defun eshell-ls-file (fileinfo &optional size-width copy-fileinfo)
- "Output FILE in long format.
-FILE may be a string, or a cons cell whose car is the filename and
-whose cdr is the list of file attributes."
+ "Output FILEINFO in long format.
+FILEINFO may be a string, or a cons cell whose car is the
+filename and whose cdr is the list of file attributes."
(if (not (cdr fileinfo))
(funcall error-func (format "%s: No such file or directory\n"
(car fileinfo)))
diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el
index def52f42e55..639098a9b9e 100644
--- a/lisp/eshell/em-pred.el
+++ b/lisp/eshell/em-pred.el
@@ -258,7 +258,7 @@ EXAMPLES:
(eshell-pred-mode))
(defun eshell-apply-modifiers (lst predicates modifiers)
- "Apply to LIST a series of PREDICATES and MODIFIERS."
+ "Apply to list LST a series of PREDICATES and MODIFIERS."
(let (stringified)
(if (stringp lst)
(setq lst (list lst)
diff --git a/lisp/eshell/em-rebind.el b/lisp/eshell/em-rebind.el
index fa61fffaec8..d70444ea109 100644
--- a/lisp/eshell/em-rebind.el
+++ b/lisp/eshell/em-rebind.el
@@ -168,7 +168,7 @@ This is default behavior of shells like bash."
(defun eshell-lock-local-map (&optional arg)
"Lock or unlock the current local keymap.
-Within a prefix arg, set the local keymap to its normal value, and
+With prefix ARG, set the local keymap to its normal value, and
lock it at that."
(interactive "P")
(if (or arg (not eshell-lock-keymap))
diff --git a/lisp/eshell/em-smart.el b/lisp/eshell/em-smart.el
index d1c83db188a..dffc8f804b7 100644
--- a/lisp/eshell/em-smart.el
+++ b/lisp/eshell/em-smart.el
@@ -131,7 +131,7 @@ only if that output can be presented in its entirely in the Eshell window."
:group 'eshell-smart)
(defcustom eshell-smart-space-goes-to-end t
- "If non-nil, space will go to end of buffer when point-max is visible.
+ "If non-nil, space will go to end of buffer when `point-max' is visible.
That is, if a command is running and the user presses SPACE at a time
when the end of the buffer is visible, point will go to the end of the
buffer and smart-display will be turned off (that is, subsequently
@@ -195,7 +195,7 @@ The options are `begin', `after' or `end'."
;; This is called by window-scroll-functions with two arguments.
(defun eshell-smart-scroll-window (wind _start)
- "Scroll the given Eshell window accordingly."
+ "Scroll the given Eshell window WIND accordingly."
(unless eshell-currently-handling-window
(let ((inhibit-point-motion-hooks t)
(eshell-currently-handling-window t))
diff --git a/lisp/eshell/esh-arg.el b/lisp/eshell/esh-arg.el
index 3cf80e45187..1990c0cfa55 100644
--- a/lisp/eshell/esh-arg.el
+++ b/lisp/eshell/esh-arg.el
@@ -203,7 +203,7 @@ treated as a literal character."
(setq eshell-current-modifiers nil))
(defun eshell-finish-arg (&optional argument)
- "Finish the current argument being processed."
+ "Finish the current ARGUMENT being processed."
(if argument
(setq eshell-current-argument argument))
(throw 'eshell-arg-done t))
diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el
index 90a8f85665a..1aac95e0b4f 100644
--- a/lisp/eshell/esh-cmd.el
+++ b/lisp/eshell/esh-cmd.el
@@ -1236,10 +1236,10 @@ or an external command."
(eshell-external-command command args))))
(defun eshell-exec-lisp (printer errprint func-or-form args form-p)
- "Execute a lisp FUNC-OR-FORM, maybe passing ARGS.
+ "Execute a Lisp FUNC-OR-FORM, maybe passing ARGS.
PRINTER and ERRPRINT are functions to use for printing regular
messages, and errors. FORM-P should be non-nil if FUNC-OR-FORM
-represent a lisp form; ARGS will be ignored in that case."
+represent a Lisp form; ARGS will be ignored in that case."
(eshell-condition-case err
(let ((result
(save-current-buffer
diff --git a/lisp/eshell/esh-ext.el b/lisp/eshell/esh-ext.el
index 9930e0884cb..fa149dd46e3 100644
--- a/lisp/eshell/esh-ext.el
+++ b/lisp/eshell/esh-ext.el
@@ -110,7 +110,7 @@ wholly ignored."
(autoload 'eshell-parse-command "esh-cmd")
(defsubst eshell-invoke-batch-file (&rest args)
- "Invoke a .BAT or .CMD file on DOS/Windows systems."
+ "Invoke a .BAT or .CMD file on MS-DOS/MS-Windows systems."
;; since CMD.EXE can't handle forward slashes in the initial
;; argument...
(setcar args (subst-char-in-string ?/ ?\\ (car args)))
diff --git a/lisp/eshell/esh-io.el b/lisp/eshell/esh-io.el
index 0e98aa0049e..0e6121031dc 100644
--- a/lisp/eshell/esh-io.el
+++ b/lisp/eshell/esh-io.el
@@ -34,7 +34,7 @@
;;;_* Redirect to a Buffer or Process
;;
;; Buffers and processes can be named with '#<buffer buffer-name>' and
-;; '#<process process-name>', respectively. As a shorthand,
+;; '#<process process-name>', respectively. As a shorthand,
;; '#<buffer-name>' without the explicit "buffer" arg is equivalent to
;; '#<buffer buffer-name>'.
;;
diff --git a/lisp/eshell/esh-mode.el b/lisp/eshell/esh-mode.el
index f9dbce9770d..a9775b7c568 100644
--- a/lisp/eshell/esh-mode.el
+++ b/lisp/eshell/esh-mode.el
@@ -499,7 +499,7 @@ and the hook `eshell-exit-hook'."
(yank)))
(defun eshell-bol ()
- "Goes to the beginning of line, then skips past the prompt, if any."
+ "Go to the beginning of line, then skip past the prompt, if any."
(interactive)
(beginning-of-line)
(and eshell-skip-prompt-function
diff --git a/lisp/eshell/eshell.el b/lisp/eshell/eshell.el
index 101ac860346..35153675faa 100644
--- a/lisp/eshell/eshell.el
+++ b/lisp/eshell/eshell.el
@@ -33,15 +33,15 @@
;; @ A high degree of configurability
;;
;; @ The ability to have the same shell on every system Emacs has been
-;; ported to. Since Eshell imposes no external requirements, and
+;; ported to. Since Eshell imposes no external requirements, and
;; relies upon only the Lisp functions exposed by Emacs, it is quite
-;; operating system independent. Several of the common UNIX
+;; operating system independent. Several of the common UNIX
;; commands, such as ls, mv, rm, ln, etc., have been implemented in
;; Lisp in order to provide a more consistent work environment.
;;
;; For those who might be using an older version of Eshell, version
-;; 2.1 represents an entirely new, module-based architecture. It
-;; supports most of the features offered by modern shells. Here is a
+;; 2.1 represents an entirely new, module-based architecture. It
+;; supports most of the features offered by modern shells. Here is a
;; brief list of some of its more visible features:
;;
;; @ Command argument completion (tcsh, zsh)
@@ -136,7 +136,7 @@
;; errors, such as 'dri' for `dir'. Since executing non-existent
;; programs is rarely the intention of the user, eshell could prompt
;; for the replacement string, and then record that in a database of
-;; known misspellings. (Note: The typo at the beginning of this
+;; known misspellings. (Note: The typo at the beginning of this
;; paragraph wasn't discovered until two months after I wrote the
;; text; it was not intentional).
;;