aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/eshell
diff options
context:
space:
mode:
authorStefan Kangas2021-09-19 12:45:56 +0200
committerStefan Kangas2021-09-19 12:59:55 +0200
commit434c176e06e2e0e645814cd12feefe994c325565 (patch)
tree3fa5d977dc8240d0eb1a182232397e7962db587b /lisp/eshell
parent68b190c8b40be4f89101541be9bdcb57e2561f89 (diff)
downloademacs-434c176e06e2e0e645814cd12feefe994c325565.tar.gz
emacs-434c176e06e2e0e645814cd12feefe994c325565.zip
; Stylistic docfixes in eshell/*.el found by checkdoc
Diffstat (limited to 'lisp/eshell')
-rw-r--r--lisp/eshell/em-pred.el2
-rw-r--r--lisp/eshell/em-term.el6
-rw-r--r--lisp/eshell/em-unix.el3
-rw-r--r--lisp/eshell/esh-cmd.el6
-rw-r--r--lisp/eshell/esh-module.el2
-rw-r--r--lisp/eshell/esh-var.el2
6 files changed, 12 insertions, 9 deletions
diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el
index 639098a9b9e..75a803d3ad4 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."
553 lst))))) 553 lst)))))
554 554
555(defun eshell-include-members (&optional invert-p) 555(defun eshell-include-members (&optional invert-p)
556 "Include only lisp members matching a regexp." 556 "Include only Lisp members matching a regexp."
557 (let ((delim (char-after)) 557 (let ((delim (char-after))
558 regexp end) 558 regexp end)
559 (forward-char) 559 (forward-char)
diff --git a/lisp/eshell/em-term.el b/lisp/eshell/em-term.el
index d199a939a31..f9d8acccf26 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'."
92 92
93(defcustom eshell-visual-options 93(defcustom eshell-visual-options
94 nil 94 nil
95 "An alist of the form 95 "An alist of commands that present their output in a visual fashion.
96It has this form:
96 97
97 ((COMMAND1 OPTION1 OPTION2...) 98 ((COMMAND1 OPTION1 OPTION2...)
98 (COMMAND2 OPTION1 ...)) 99 (COMMAND2 OPTION1 ...))
99 100
100of commands with options that present their output in a visual 101For example, a sensible entry would be
101fashion. For example, a sensible entry would be
102 102
103 (\"git\" \"--help\" \"--paginate\") 103 (\"git\" \"--help\" \"--paginate\")
104 104
diff --git a/lisp/eshell/em-unix.el b/lisp/eshell/em-unix.el
index 5b400c74fca..e71edaf4765 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."
165(put 'eshell/man 'eshell-no-numeric-conversions t) 165(put 'eshell/man 'eshell-no-numeric-conversions t)
166 166
167(defun eshell/info (&rest args) 167(defun eshell/info (&rest args)
168 "Run the info command in-frame with the same behavior as command-line `info', ie: 168 "Run the info command in-frame with the same behavior as command-line `info'.
169For example:
169 `info' => goes to top info window 170 `info' => goes to top info window
170 `info arg1' => IF arg1 is a file, then visits arg1 171 `info arg1' => IF arg1 is a file, then visits arg1
171 `info arg1' => OTHERWISE goes to top info window and then menu item arg1 172 `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 1aac95e0b4f..a2464ad4a98 100644
--- a/lisp/eshell/esh-cmd.el
+++ b/lisp/eshell/esh-cmd.el
@@ -116,9 +116,9 @@
116 (&optional form stub paring form-only)) 116 (&optional form stub paring form-only))
117 117
118(defgroup eshell-cmd nil 118(defgroup eshell-cmd nil
119 "Executing an Eshell command is as simple as typing it in and 119 "Executing an Eshell command is as simple as typing it in and \
120pressing <RET>. There are several different kinds of commands, 120pressing \\<eshell-mode-map>\\[eshell-send-input].
121however." 121There are several different kinds of commands, however."
122 :tag "Command invocation" 122 :tag "Command invocation"
123 ;; :link '(info-link "(eshell)Command invocation") 123 ;; :link '(info-link "(eshell)Command invocation")
124 :group 'eshell) 124 :group 'eshell)
diff --git a/lisp/eshell/esh-module.el b/lisp/eshell/esh-module.el
index 703179504c1..97ffedae62a 100644
--- a/lisp/eshell/esh-module.el
+++ b/lisp/eshell/esh-module.el
@@ -20,6 +20,8 @@
20;; You should have received a copy of the GNU General Public License 20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. 21;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
22 22
23;;; Commentary:
24
23;;; Code: 25;;; Code:
24 26
25(require 'esh-util) 27(require 'esh-util)
diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el
index 5dc6a193050..fa9853ae00a 100644
--- a/lisp/eshell/esh-var.el
+++ b/lisp/eshell/esh-var.el
@@ -45,7 +45,7 @@
45;; 45;;
46;; $(lisp) 46;; $(lisp)
47;; 47;;
48;; Returns result of lisp evaluation. Note: Used alone like this, it 48;; Returns result of Lisp evaluation. Note: Used alone like this, it
49;; is identical to just saying (lisp); but with the variable expansion 49;; is identical to just saying (lisp); but with the variable expansion
50;; form, the result may be interpolated a larger string, such as 50;; form, the result may be interpolated a larger string, such as
51;; '$(lisp)/other'. 51;; '$(lisp)/other'.