[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 434c176 1/2: ; Stylistic docfixes in eshell/*.el found by checkdo
From: |
Stefan Kangas |
Subject: |
master 434c176 1/2: ; Stylistic docfixes in eshell/*.el found by checkdoc |
Date: |
Sun, 19 Sep 2021 07:01:02 -0400 (EDT) |
branch: master
commit 434c176e06e2e0e645814cd12feefe994c325565
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
; Stylistic docfixes in eshell/*.el found by checkdoc
---
lisp/eshell/em-pred.el | 2 +-
lisp/eshell/em-term.el | 6 +++---
lisp/eshell/em-unix.el | 3 ++-
lisp/eshell/esh-cmd.el | 6 +++---
lisp/eshell/esh-module.el | 2 ++
lisp/eshell/esh-var.el | 2 +-
6 files changed, 12 insertions(+), 9 deletions(-)
diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el
index 639098a..75a803d 100644
--- a/lisp/eshell/em-pred.el
+++ b/lisp/eshell/em-pred.el
@@ -553,7 +553,7 @@ that `ls -l' will show in the first column of its display."
lst)))))
(defun eshell-include-members (&optional invert-p)
- "Include only lisp members matching a regexp."
+ "Include only Lisp members matching a regexp."
(let ((delim (char-after))
regexp end)
(forward-char)
diff --git a/lisp/eshell/em-term.el b/lisp/eshell/em-term.el
index d199a93..f9d8acc 100644
--- a/lisp/eshell/em-term.el
+++ b/lisp/eshell/em-term.el
@@ -92,13 +92,13 @@ See also `eshell-visual-commands' and
`eshell-visual-options'."
(defcustom eshell-visual-options
nil
- "An alist of the form
+ "An alist of commands that present their output in a visual fashion.
+It has this form:
((COMMAND1 OPTION1 OPTION2...)
(COMMAND2 OPTION1 ...))
-of commands with options that present their output in a visual
-fashion. For example, a sensible entry would be
+For example, a sensible entry would be
(\"git\" \"--help\" \"--paginate\")
diff --git a/lisp/eshell/em-unix.el b/lisp/eshell/em-unix.el
index 5b400c7..e71edaf 100644
--- a/lisp/eshell/em-unix.el
+++ b/lisp/eshell/em-unix.el
@@ -165,7 +165,8 @@ Otherwise, Emacs will attempt to use rsh to invoke du on
the remote machine."
(put 'eshell/man 'eshell-no-numeric-conversions t)
(defun eshell/info (&rest args)
- "Run the info command in-frame with the same behavior as command-line
`info', ie:
+ "Run the info command in-frame with the same behavior as command-line `info'.
+For example:
`info' => goes to top info window
`info arg1' => IF arg1 is a file, then visits arg1
`info arg1' => OTHERWISE goes to top info window and then menu item arg1
diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el
index 1aac95e..a2464ad 100644
--- a/lisp/eshell/esh-cmd.el
+++ b/lisp/eshell/esh-cmd.el
@@ -116,9 +116,9 @@
(&optional form stub paring form-only))
(defgroup eshell-cmd nil
- "Executing an Eshell command is as simple as typing it in and
-pressing <RET>. There are several different kinds of commands,
-however."
+ "Executing an Eshell command is as simple as typing it in and \
+pressing \\<eshell-mode-map>\\[eshell-send-input].
+There are several different kinds of commands, however."
:tag "Command invocation"
;; :link '(info-link "(eshell)Command invocation")
:group 'eshell)
diff --git a/lisp/eshell/esh-module.el b/lisp/eshell/esh-module.el
index 7031795..97ffeda 100644
--- a/lisp/eshell/esh-module.el
+++ b/lisp/eshell/esh-module.el
@@ -20,6 +20,8 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
+;;; Commentary:
+
;;; Code:
(require 'esh-util)
diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el
index 5dc6a19..fa9853a 100644
--- a/lisp/eshell/esh-var.el
+++ b/lisp/eshell/esh-var.el
@@ -45,7 +45,7 @@
;;
;; $(lisp)
;;
-;; Returns result of lisp evaluation. Note: Used alone like this, it
+;; Returns result of Lisp evaluation. Note: Used alone like this, it
;; is identical to just saying (lisp); but with the variable expansion
;; form, the result may be interpolated a larger string, such as
;; '$(lisp)/other'.