; Stylistic docfixes in eshell/*.el found by checkdoc
This commit is contained in:
parent
68b190c8b4
commit
434c176e06
6 changed files with 12 additions and 9 deletions
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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\")
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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'.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue