procyberian/emacs
1
0
Fork 0
Code Issues 1 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Capitalize "Dired" and "Lisp" in docstrings

Browse source 
* lisp/desktop.el (desktop-no-desktop-file-hook):
* lisp/dired-x.el (dired-mark-sexp):
* lisp/dired.el (dired-make-directory-clickable)
(dired-map-over-marks, dired-file-name-at-point)
(dired-save-positions, dired-buffers-for-dir)
(dired-buffers-for-dir-or-subdir, dired-fun-in-all-buffers)
(dired-remove-entry, dired-delete-entry, dired-jump):
* lisp/files.el (save-buffer):
* lisp/find-dired.el (find-ls-option):
* lisp/hilit-chg.el:
* lisp/locate.el (locate-mode):
* lisp/msb.el (msb-dired-item-handler, msb-sort-by-directory):
* lisp/printing.el (pr-ps-printer-alist, pr-ps-utility-alist):
* lisp/uniquify.el (uniquify-trailing-separator-p):
* lisp/wdired.el (wdired, wdired-change-to-dired-mode, wdired-exit):
* lisp/woman.el (woman-dired-define-keys, woman-dired-find-file):
Capitalize "Dired" and "Lisp" in docstrings.  Found with checkdoc.
This commit is contained in:
Stefan Kangas 2024-07-10 00:26:22 +02:00
parent 37475c9af7
commit 5cf8d60e0d
12 changed files with 37 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lisp/desktop.el
View file

@ -122,7 +122,7 @@
;; things you did not mean to keep. Use M-x desktop-clear RET.
;; Thanks to hetrick@phys.uva.nl (Jim Hetrick) for useful ideas.
;; avk@rtsg.mot.com (Andrew V. Klein) for a dired tip.
;; avk@rtsg.mot.com (Andrew V. Klein) for a Dired tip.
;; chris@tecc.co.uk (Chris Boucher) for a mark tip.
;; f89-kam@nada.kth.se (Klas Mellbourn) for a mh-e tip.
;; kifer@cs.stonybrook.edu (M. Kifer) for a bug hunt.
@ -296,7 +296,7 @@ If nil, just print error messages in the message buffer."
(defcustom desktop-no-desktop-file-hook nil
"Normal hook run when `desktop-read' can't find a desktop file.
Run in the directory in which the desktop file was sought.
May be used to show a dired buffer."
May be used to show a Dired buffer."
:type 'hook
:group 'desktop
:version "22.1")

4
lisp/dired-x.el
View file

@ -28,7 +28,7 @@
;; This is based on Sebastian Kremer's excellent dired-x.el (Dired Extra),
;; version 1.191, adapted for GNU Emacs. See the `dired-x' Info manual.
;; At load time dired-x.el will install itself and bind some dired keys.
;; At load time dired-x.el will install itself and bind some Dired keys.
;; Some dired.el and dired-aux.el functions have extra features if
;; dired-x is loaded.
@ -858,7 +858,7 @@ sure that a trailing letter in STR is one of BKkMGTPEZYRQ."
"Mark files for which PREDICATE returns non-nil.
With a prefix arg, unmark or unflag those files instead.
PREDICATE is a lisp expression that can refer to the following symbols:
PREDICATE is a Lisp expression that can refer to the following symbols:
inode [integer] the inode of the file (only for ls -i output)
s [integer] the size of the file for ls -s output

20
lisp/dired.el
View file

@ -350,7 +350,7 @@ with the buffer narrowed to the listing."
;; functions probably depend on the dired-subdir-alist to be OK.
(defcustom dired-make-directory-clickable t
"When non-nil, make the directory at the start of the dired buffer clickable."
"When non-nil, make the directory at the start of the Dired buffer clickable."
:version "29.1"
:group 'dired
:type 'boolean)
@ -941,7 +941,7 @@ If ARG is `marked', don't return the current file if nothing else
is marked.
If optional third arg SHOW-PROGRESS evaluates to non-nil,
redisplay the dired buffer after each file is processed.
redisplay the Dired buffer after each file is processed.
No guarantee is made about the position on the marked line.
BODY must ensure this itself if it depends on this.
@ -1145,7 +1145,7 @@ ERROR can be a string with the error message."
;; nil default-directory nil))))))))
(defun dired-file-name-at-point ()
"Try to get a file name at point in the current dired buffer.
"Try to get a file name at point in the current Dired buffer.
This hook is intended to be put in `file-name-at-point-functions'.
Note that it returns an abbreviated name that can't be used
as an argument to `dired-goto-file'."
@ -2133,7 +2133,7 @@ BUFFER-POSITION is the point position in the current Dired buffer.
It has the form (BUFFER DIRED-FILENAME BUFFER-LINE-NUMBER).
WINDOW-POSITIONS are current positions in all windows displaying
this dired buffer. The window positions have the form (WINDOW
this Dired buffer. The window positions have the form (WINDOW
DIRED-FILENAME WINDOW-LINE-NUMBER).
We store line numbers instead of point positions because the header
@ -3465,7 +3465,7 @@ You can then feed the file name(s) to other commands with \\[yank]."
If FILE is non-nil, include only those whose wildcard pattern (if any)
matches FILE.
The list is in reverse order of buffer creation, most recent last.
As a side effect, killed dired buffers for DIR are removed from
As a side effect, killed Dired buffers for DIR are removed from
`dired-buffers'."
(setq dir (file-name-as-directory (expand-file-name dir)))
(let (result buf)
@ -3492,7 +3492,7 @@ As a side effect, killed dired buffers for DIR are removed from
(defun dired-buffers-for-dir-or-subdir (dir)
"Return a list of buffers for DIR or a subdirectory thereof.
As a side effect, killed dired buffers for DIR are removed from
As a side effect, killed Dired buffers for DIR are removed from
`dired-buffers'."
(setq dir (file-name-as-directory dir))
(let (result buf)
@ -4049,7 +4049,7 @@ non-empty directories is allowed."
(dired-move-to-filename))
(defun dired-fun-in-all-buffers (directory file fun &rest args)
"In all buffers dired'ing DIRECTORY, run FUN with ARGS.
"In all buffers Dired'ing DIRECTORY, run FUN with ARGS.
If the buffer has a wildcard pattern, check that it matches FILE.
\(FILE does not include a directory component.)
FILE may be nil, in which case ignore it.
@ -4064,7 +4064,7 @@ Return list of buffers where FUN succeeded (i.e., returned non-nil)."
;; Delete the entry for FILE from
(defun dired-remove-entry (file)
"Remove entry FILE in the current dired buffer.
"Remove entry FILE in the current Dired buffer.
Note this doesn't delete FILE in the file system.
See `dired-delete-file' in case you wish that."
(save-excursion
@ -4074,7 +4074,7 @@ See `dired-delete-file' in case you wish that."
(line-beginning-position 2))))))
(defun dired-delete-entry (file)
"Remove entry FILE in the current dired buffer.
"Remove entry FILE in the current Dired buffer.
Like `dired-remove-entry' followed by `dired-clean-up-after-deletion'.
Note this doesn't delete FILE in the file system.
See `dired-delete-file' in case you wish that."
@ -5139,7 +5139,7 @@ move to that file's line in the directory listing.
If the current buffer isn't visiting a file, Dired `default-directory'.
If in Dired already, pop up a level and goto old directory's line.
In case the proper Dired file line cannot be found, refresh the dired
In case the proper Dired file line cannot be found, refresh the Dired
buffer and try again.
When OTHER-WINDOW is non-nil, jump to Dired buffer in other window.

2
lisp/files.el
View file

@ -5769,7 +5769,7 @@ We don't want excessive versions piling up, so there are variables
`kept-old-versions', which tells Emacs how many oldest versions to keep,
and `kept-new-versions', which tells how many newest versions to keep.
Defaults are 2 old versions and 2 new.
`dired-kept-versions' controls dired's clean-directory (.) command.
`dired-kept-versions' controls Dired's clean-directory (.) command.
If `delete-old-versions' is nil, system will query user
before trimming versions. Otherwise it does it silently.

2
lisp/find-dired.el
View file

@ -76,7 +76,7 @@ than the latter."
This is a cons of two strings (FIND-OPTION . LS-SWITCHES).
FIND-OPTION is the option (or options) passed to `find' to produce
a file listing in the desired format. LS-SWITCHES is a set of
`ls' switches that tell dired how to parse the output of `find'.
`ls' switches that tell Dired how to parse the output of `find'.
The two options must be set to compatible values.
For example, to use human-readable file sizes with GNU ls:

2
lisp/hilit-chg.el
View file

@ -100,7 +100,7 @@
;; * nil -- then no buffers are suitable;
;; * a function -- this function is called and the result is used. As
;; an example, if the value is `buffer-file-name' then all buffers
;; who are visiting files are suitable, but others (like dired
;; who are visiting files are suitable, but others (like Dired
;; buffers) are not;
;; * a list -- then the buffer is suitable if and only if its mode is in the
;; list, except if the first element is `not', in which case the test

8
lisp/locate.el
View file

@ -22,7 +22,7 @@
;;; Commentary:
;; Search a database of files and use dired commands on the result.
;; Search a database of files and use Dired commands on the result.
;;
;; Locate.el provides an interface to a program which searches a
;; database of file names. By default, this program is the GNU locate
@ -60,7 +60,7 @@
;; character in the file name and the last character in the file name.
;;
;; To use locate-mode, simply type M-x locate and then the string
;; you wish to find. You can use almost all of the dired commands in
;; you wish to find. You can use almost all of the Dired commands in
;; the resulting *Locate* buffer. It is worth noting that your commands
;; do not, of course, affect the file database. For example, if you
;; compress a file in the locate buffer, the actual file will be
@ -90,7 +90,7 @@
;;
;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
;;
;; For certain dired commands to work right, you should also include the
;; For certain Dired commands to work right, you should also include the
;; following in your _emacs/.emacs:
;;
;; (defadvice dired-make-relative (before set-no-error activate)
@ -439,7 +439,7 @@ file name or is inside a subdirectory."
(define-derived-mode locate-mode special-mode "Locate"
"Major mode for the `*Locate*' buffer made by \\[locate].
\\<locate-mode-map>\
In that buffer, you can use almost all the usual dired bindings.
In that buffer, you can use almost all the usual Dired bindings.
\\[locate-find-directory] visits the directory of the file on the current line.
This function runs `locate-mode-hook' before returning.

4
lisp/msb.el
View file

@ -398,7 +398,7 @@ Optional second argument MAXBUF is completely ignored."
(buffer-name)))))
(defun msb-dired-item-handler (_buffer &optional _maxbuf)
"Create one string item, concerning a dired BUFFER, for the buffer menu.
"Create one string item, concerning a Dired BUFFER, for the buffer menu.
The item looks like:
*% <buffer-name>
The `*' appears only if the buffer is marked as modified.
@ -434,7 +434,7 @@ An item looks like (NAME . BUFFER)."
(defun msb-sort-by-directory (item1 item2)
"Sort the items ITEM1 and ITEM2 by directory name. Made for dired.
"Sort the items ITEM1 and ITEM2 by directory name. Made for Dired.
An item look like (NAME . BUFFER)."
(string-lessp (with-current-buffer (cdr item1)
(msb--dired-directory))

6
lisp/printing.el
View file

@ -1663,7 +1663,7 @@ DEFAULT It's a way to set default values when this entry is selected.
(pr-gs-device . (my-gs-device t))
This variable should be modified by customization engine. If this variable is
modified by other means (for example, a lisp function), use `pr-update-menus'
modified by other means (for example, a Lisp function), use `pr-update-menus'
function (see it for documentation) to update PostScript printer menu.
Examples:
@ -2335,7 +2335,7 @@ DEFAULT It's a way to set default values when this entry is selected.
(set VARIABLE (eval VALUE))
Note that VALUE can be any valid lisp expression. So, don't
Note that VALUE can be any valid Lisp expression. So, don't
forget to quote symbols and constant lists.
If VARIABLE is the special keyword `inherits-from:', VALUE must
be a symbol name setting defined in `pr-setting-database' from
@ -2347,7 +2347,7 @@ DEFAULT It's a way to set default values when this entry is selected.
(pr-gs-device . (my-gs-device t))
This variable should be modified by customization engine. If this variable is
modified by other means (for example, a lisp function), use `pr-update-menus'
modified by other means (for example, a Lisp function), use `pr-update-menus'
function (see it for documentation) to update PostScript utility menu.
NOTE: Don't forget to download and install the utilities declared on

4
lisp/uniquify.el
View file

@ -28,7 +28,7 @@
;; Emacs's traditional method for making buffer names unique adds <2>, <3>,
;; etc. to the end of (all but one of) the buffers. This file replaces
;; that behavior, for buffers visiting files and dired buffers, with a
;; that behavior, for buffers visiting files and Dired buffers, with a
;; uniquification that adds parts of the file name until the buffer names
;; are unique. For instance, buffers visiting /u/mernst/tmp/Makefile and
;; /usr/projects/zaphod/Makefile would be named Makefile|tmp and
@ -148,7 +148,7 @@ file name components (default \"\\\")."
:type '(choice (const nil) string))
(defcustom uniquify-trailing-separator-p nil
"If non-nil, add a file name separator to dired buffer names.
"If non-nil, add a file name separator to Dired buffer names.
If `uniquify-buffer-name-style' is `forward', add the separator at the end;
if it is `reverse', add the separator at the beginning; otherwise, this
variable is ignored."

10
lisp/wdired.el
View file

@ -35,7 +35,7 @@
;; Dired buffer editable, by changing the buffer mode (which inhibits
;; all of the commands of Dired mode). Here you can edit the names of
;; one or more files and directories, and when you press `C-c C-c',
;; the renaming takes effect and you are back to dired mode.
;; the renaming takes effect and you are back to Dired mode.
;;
;; Other things you can do with WDired:
;;
@ -72,7 +72,7 @@
(autoload 'dired-do-create-files-regexp "dired-aux")
(defgroup wdired nil
"Mode to rename files by editing their names in dired buffers."
"Mode to rename files by editing their names in Dired buffers."
:group 'dired)
(defcustom wdired-use-interactive-rename nil
@ -438,7 +438,7 @@ non-nil means return old filename."
(concat (dired-current-directory) file))))))
(defun wdired-change-to-dired-mode ()
"Change the mode back to dired."
"Change the mode back to Dired."
(or (eq major-mode 'wdired-mode)
(error "Not a Wdired buffer"))
(let ((inhibit-read-only t))
@ -677,8 +677,8 @@ non-nil means return old filename."
(make-directory (file-name-directory file-new) t)))
(defun wdired-exit ()
"Exit wdired and return to dired mode.
Just return to dired mode if there are no changes. Otherwise,
"Exit wdired and return to Dired mode.
Just return to Dired mode if there are no changes. Otherwise,
ask a yes-or-no question whether to save or cancel changes,
and proceed depending on the answer."
(interactive)

8
lisp/woman.el
View file

@ -92,7 +92,7 @@
;; (add-hook 'dired-mode-hook
;; (lambda ()
;; (define-key dired-mode-map "W" 'woman-dired-find-file)))
;; and open the directory containing the man page file using dired,
;; and open the directory containing the man page file using Dired,
;; put the cursor on the file, and press `W'.
;; In each case, the result should (!) be a buffer in Man mode showing
@ -102,7 +102,7 @@
;; manual-browsing facility rather than `WoMan' -- this is
;; intentional!)
;; (By default, WoMan will automatically define the dired keys "W" and
;; (By default, WoMan will automatically define the Dired keys "W" and
;; "w" when it loads, but only if they are not already defined. This
;; behavior is controlled by the user option `woman-dired-keys'.
;; Note that the `dired-x' (dired extra) package binds
@ -1526,7 +1526,7 @@ Also make each path-info component into a list.
(woman-dired-define-key key)))
(defun woman-dired-define-keys ()
"Define dired keys to run WoMan according to `woman-dired-keys'."
"Define Dired keys to run WoMan according to `woman-dired-keys'."
(if woman-dired-keys
(if (listp woman-dired-keys)
(mapc #'woman-dired-define-key woman-dired-keys)
@ -1544,7 +1544,7 @@ Also make each path-info component into a list.
;;;###autoload
(defun woman-dired-find-file ()
"In dired, run the WoMan man-page browser on this file."
"In Dired, run the WoMan man-page browser on this file."
(interactive)
(woman-find-file (dired-get-filename)))