From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Tue, 2 Mar 2021 07:07:59 +0000 (+0100)
Subject: Improve the 'dired-do-kill-lines' doc string
X-Git-Tag: emacs-27.2-rc1~14
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ed2b23ecc1;p=emacs.git

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)
---

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)