From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Mon, 7 Oct 2019 17:44:17 +0000 (+0200)
Subject: dired-move-to-filename doc string fix
X-Git-Tag: archive/raspbian/1%29.2+1-2+rpi1^2~5^2~19^2~1619
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=7b3932f2440df61acd20743f230b05ffc4f8d2d8;p=emacs.git

dired-move-to-filename doc string fix

* lisp/dired.el (dired-move-to-filename): Document the parameters
(bug#17566).
---

diff --git a/lisp/dired.el b/lisp/dired.el
index efe00d1ba40..6e48d28b4cf 100644
--- a/lisp/dired.el
+++ b/lisp/dired.el
@@ -2582,7 +2582,13 @@ See options: `dired-hide-details-hide-symlink-targets' and
 ;; Returns position (point) or nil if no filename on this line."
 (defun dired-move-to-filename (&optional raise-error eol)
   "Move to the beginning of the filename on the current line.
-Return the position of the beginning of the filename, or nil if none found."
+Return the position of the beginning of the filename, or nil if none found.
+
+If RAISE-ERROR, signal an error if we can't find the filename on
+the current line.
+
+If EOL, it should be an position to use instead of
+`line-end-position' as the end of the line."
   ;; This is the UNIX version.
   (or eol (setq eol (line-end-position)))
   (beginning-of-line)