]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve the dired-do-kill-lines doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Tue, 2 Mar 2021 07:07:59 +0000 (08:07 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Tue, 2 Mar 2021 07:07:59 +0000 (08:07 +0100)
* lisp/dired-aux.el (dired-do-kill-lines): Document the FMT
parameter (bug#46867).

lisp/dired-aux.el

index a94bdf5b42ef5cf1be0b5286328e60d6e7fae5d1..d5f491087671aa015460bd9b9cf951b522f8ec53 100644 (file)
@@ -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)