From: Stefan Kangas <stefankangas@gmail.com>
Date: Mon, 8 Jul 2024 14:50:17 +0000 (+0200)
Subject: Checkdoc fixes in `eshell/*.el`
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ee7f8bc2a2ffeb86e111fe375198ca6d87a12686;p=emacs.git

Checkdoc fixes in `eshell/*.el`

* lisp/eshell/em-elecslash.el:
* lisp/eshell/em-extpipe.el:
* lisp/eshell/em-pred.el (eshell-get-delimited-modifier-argument):
* lisp/eshell/esh-cmd.el (eshell--unmark-deferrable)
(eshell-named-command-hook):
* lisp/eshell/esh-module.el (eshell-module--feature-name):
* lisp/eshell/esh-util.el (eshell-find-delimiter): Checkdoc fixes.

(cherry picked from commit 7350457c793f5f6b7cd331b85ef5779ca17a1c27)
---

diff --git a/lisp/eshell/em-elecslash.el b/lisp/eshell/em-elecslash.el
index 60f2c6e4039..a06e5be721d 100644
--- a/lisp/eshell/em-elecslash.el
+++ b/lisp/eshell/em-elecslash.el
@@ -108,4 +108,4 @@ insertion."
         (insert "/")))))
 
 (provide 'em-elecslash)
-;;; esh-elecslash.el ends here
+;;; em-elecslash.el ends here
diff --git a/lisp/eshell/em-extpipe.el b/lisp/eshell/em-extpipe.el
index 4c92653a3a3..dd06a055755 100644
--- a/lisp/eshell/em-extpipe.el
+++ b/lisp/eshell/em-extpipe.el
@@ -217,4 +217,4 @@ as though it were Eshell syntax."
   (error "Unhandled external pipeline in input text"))
 
 (provide 'em-extpipe)
-;;; esh-extpipe.el ends here
+;;; em-extpipe.el ends here
diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el
index 0be262641ea..a9274e7c60d 100644
--- a/lisp/eshell/em-pred.el
+++ b/lisp/eshell/em-pred.el
@@ -417,7 +417,7 @@ delimiter.
 If CHAINED-P is true, then another delimited modifier argument
 will immediately follow this one.  In this case, when the opening
 and closing delimiters are the same, update point to be just
-before the closing delimiter. This allows modifiers like
+before the closing delimiter.  This allows modifiers like
 `:s/match/repl' to work as expected."
   (when-let* ((open (char-after))
               (close (cdr (assoc open eshell-pred-delimiter-pairs)))
diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el
index aaae19df5d6..0b3137127d2 100644
--- a/lisp/eshell/esh-cmd.el
+++ b/lisp/eshell/esh-cmd.el
@@ -154,8 +154,7 @@ To prevent a command from executing at all, set
   :type 'hook)
 
 (defcustom eshell-named-command-hook nil
-  "A set of functions called before
-a named command is invoked.
+  "A set of functions called before a named command is invoked.
 Each function will be passed the command name and arguments that were
 passed to `eshell-named-command'.
 
@@ -816,7 +815,7 @@ current ones (see `eshell-duplicate-handles')."
 This changes COMMAND in-place by converting function calls listed
 in `eshell-deferrable-commands' to their non-deferrable forms so
 that Eshell doesn't erroneously allow deferring it.  For example,
-`eshell-named-command' becomes `eshell-named-command*', "
+`eshell-named-command' becomes `eshell-named-command*'."
   (let ((cmd command))
     (when (memq (car cmd) '(let progn))
       (setq cmd (car (last cmd))))
diff --git a/lisp/eshell/esh-module.el b/lisp/eshell/esh-module.el
index db808f8597a..a139bc186d7 100644
--- a/lisp/eshell/esh-module.el
+++ b/lisp/eshell/esh-module.el
@@ -99,7 +99,7 @@ extension module; if nil, KIND defaults to `extension'."
   (let ((module-name (symbol-name module))
         (prefix (cond ((eq kind 'core) "esh-")
                       ((memq kind '(extension nil)) "em-")
-                      (t (error "unknown module kind %s" kind)))))
+                      (t (error "Unknown module kind %s" kind)))))
     (if (string-match "^eshell-\\(.*\\)" module-name)
 	(concat prefix (match-string 1 module-name))
       (error "Invalid Eshell module name: %s" module))))
diff --git a/lisp/eshell/esh-util.el b/lisp/eshell/esh-util.el
index e2657dbabd8..46083184aaa 100644
--- a/lisp/eshell/esh-util.el
+++ b/lisp/eshell/esh-util.el
@@ -288,7 +288,7 @@ The value returned is the last form in BODY."
 (defun eshell-find-delimiter
   (open close &optional bound reverse-p backslash-p)
   "From point, find the CLOSE delimiter corresponding to OPEN.
-The matching is bounded by BOUND. If REVERSE-P is non-nil,
+The matching is bounded by BOUND.  If REVERSE-P is non-nil,
 process the region backwards.
 
 If BACKSLASH-P is non-nil, or OPEN and CLOSE are different