Improve docstring of image-dired-show-all-from-dir

* lisp/image/image-dired.el (image-dired-show-all-from-dir):
Improve docstring.
This commit is contained in:
Stefan Kangas 2025-01-07 08:15:41 +01:00
parent d4503ccc27
commit e41a7d8127
2 changed files with 17 additions and 6 deletions

View file

@ -318,6 +318,12 @@ modal editing packages.
** Smerge
*** New command 'smerge-extend' extends a conflict over surrounding lines.
** Image Dired
*** 'image-dired-show-all-from-dir' takes the same first argument as 'dired'.
This allows passing a string with wildcards, or a cons cell where the
first element is a list and the rest is a list of files.
** Browse URL
*** New user option 'browse-url-transform-alist'.

View file

@ -618,17 +618,22 @@ thumbnail buffer to be selected."
(image-dired--update-header-line))))
;;;###autoload
(defun image-dired-show-all-from-dir (dir)
"Make a thumbnail buffer for all images in DIR and display it.
Any file matching `image-dired--file-name-regexp' is considered an
image file.
(defun image-dired-show-all-from-dir (dirname)
"Make a thumbnail buffer for all images in DIRNAME and display it.
The DIRNAME argument is passed along to `dired', and can therefore be
either a string with wildcards or a cons, as described in the
documentation for that function. Refer to it for more details.
If the number of image files in DIR exceeds
`image-dired-show-all-from-dir-max-files', ask for confirmation
before creating the thumbnail buffer. If that variable is nil,
never ask for confirmation."
never ask for confirmation.
Any file matching `image-dired--file-name-regexp' is considered an
image file."
(interactive "DShow thumbnails for directory: ")
(dired dir)
(dired dirname)
(dired-mark-files-regexp (image-dired--file-name-regexp))
(let ((files (dired-get-marked-files nil nil nil t))
(dired-default-directory default-directory))