summaryrefslogtreecommitdiff
path: root/lisp/dired-aux.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2021-03-02 08:07:59 +0100
committerLars Ingebrigtsen <larsi@gnus.org>2021-03-02 08:07:59 +0100
commitb9cb3b904008a80c69ab433f4851377967b100db (patch)
tree4c1936ffa0446e90c8e15718b390d8d8acc8223d /lisp/dired-aux.el
parent165353674e5fe7109ba9cbf526de0333902b7851 (diff)
downloademacs-b9cb3b904008a80c69ab433f4851377967b100db.tar.gz
emacs-b9cb3b904008a80c69ab433f4851377967b100db.tar.bz2
emacs-b9cb3b904008a80c69ab433f4851377967b100db.zip
Improve the dired-do-kill-lines doc string
* lisp/dired-aux.el (dired-do-kill-lines): Document the FMT parameter (bug#46867).
Diffstat (limited to 'lisp/dired-aux.el')
-rw-r--r--lisp/dired-aux.el9
1 files changed, 7 insertions, 2 deletions
diff --git a/lisp/dired-aux.el b/lisp/dired-aux.el
index a94bdf5b42e..d5f49108767 100644
--- a/lisp/dired-aux.el
+++ b/lisp/dired-aux.el
@@ -1072,8 +1072,13 @@ To kill an entire subdirectory \(without killing its line in the
parent directory), go to its directory header line and use this
command with a prefix argument (the value does not matter).
-To undo the killing, the undo command can be used as normally."
- ;; Returns count of killed lines. FMT="" suppresses message.
+To undo the killing, the undo command can be used as normally.
+
+This function returns the number of killed lines.
+
+FMT is a format string used for messaging the user about the
+killed lines, and defaults to \"Killed %d line%s.\" if not
+present. A FMT of \"\" will suppress the messaging."
(interactive "P")
(if arg
(if (dired-get-subdir)