summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2021-03-02 08:07:59 +0100
committerEli Zaretskii <eliz@gnu.org>2021-03-02 16:04:17 +0200
commited2b23ecc10925b5b29ab13949a5d154c7d0cbe6 (patch)
tree6a56c1467dc119cd1da4e20e2a8de6c4f61ae331
parent8c93becb35dc387ec307f54406324593b1af1975 (diff)
downloademacs-ed2b23ecc10925b5b29ab13949a5d154c7d0cbe6.tar.gz
Improve the 'dired-do-kill-lines' doc string
* lisp/dired-aux.el (dired-do-kill-lines): Document the FMT parameter (bug#46867). (cherry picked from commit b9cb3b904008a80c69ab433f4851377967b100db)
-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 cef4de1f1c6..6c7908118a8 100644
--- a/lisp/dired-aux.el
+++ b/lisp/dired-aux.el
@@ -954,8 +954,13 @@ Dired buffer as a subdirectory, then it deletes that subdirectory
from the buffer as well.
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)."
- ;; Returns count of killed lines. FMT="" suppresses message.
+command with a prefix argument (the value does not matter).
+
+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)