]> git.eshelyaron.com Git - emacs.git/commitdiff
Checkdoc fixes in `eshell/*.el`
authorStefan Kangas <stefankangas@gmail.com>
Mon, 8 Jul 2024 14:50:17 +0000 (16:50 +0200)
committerEshel Yaron <me@eshelyaron.com>
Tue, 9 Jul 2024 17:50:20 +0000 (19:50 +0200)
* 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)

lisp/eshell/em-elecslash.el
lisp/eshell/em-extpipe.el
lisp/eshell/em-pred.el
lisp/eshell/esh-cmd.el
lisp/eshell/esh-module.el
lisp/eshell/esh-util.el

index 60f2c6e4039ad2fcc2aa695798a365e65203d4a4..a06e5be721d36d21e242b0c1858ce6538ff18e69 100644 (file)
@@ -108,4 +108,4 @@ insertion."
         (insert "/")))))
 
 (provide 'em-elecslash)
-;;; esh-elecslash.el ends here
+;;; em-elecslash.el ends here
index 4c92653a3a352609c4aecb18785798e076a15f2d..dd06a055755a51cc383f8de24fb957bb0bf448fd 100644 (file)
@@ -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
index 0be262641eaaf82911fd8e60f59340835ff25d84..a9274e7c60d2e6608e6fbafdf2d182180522a700 100644 (file)
@@ -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)))
index aaae19df5d675fdd7880e1d2057e94a6ee696cee..0b3137127d2aec736c62a539a479e6c0db1cbb7c 100644 (file)
@@ -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))))
index db808f8597ad0696207d17321e3c4e08bc6bd0f9..a139bc186d7dc9360ceaee9a6271011d66745cc2 100644 (file)
@@ -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))))
index e2657dbabd81573e680548410e619d66f5fa7a3e..46083184aaa76721d9b4c6f9e0846c8ccb5ba207 100644 (file)
@@ -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