; Stylistic docfixes in eshell/*.el found by checkdoc

diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el
index 639098a9b9eaa35177fe10cdc095ef3e554d80f5..75a803d3ad464d50c847a7c1660590e722547ed3 100644 (file)
--- 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 d199a939a316f9d20c1d3cf1bca79fa920c96c7e..f9d8acccf26941702fb152361a141dbb00c64f00 100644 (file)
--- 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 5b400c74fca9ae3ef681d98cbec4698db68f8e12..e71edaf4765963babac838f5f66e1755ce681413 100644 (file)
--- 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 1aac95e0b4f401cac4723855ba1fa4a4dea979ea..a2464ad4a983bec1f1ee601ff1c7cc1dc5e24c71 100644 (file)
--- 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 703179504c14069cb92517505c2217304dbeab79..97ffedae62ab27808f798b880e38550ec1457c20 100644 (file)
--- 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 5dc6a193050d2b07e61af06aaacf5c9c19443b60..fa9853ae00a1befe5362df21106d6bd76a9c190c 100644 (file)
--- 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'.