[Emacs-diffs] master 7b3932f: dired-move-to-filename doc string fix

[Lars Ingebrigtsen]

branch: master
commit 7b3932f2440df61acd20743f230b05ffc4f8d2d8
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    dired-move-to-filename doc string fix
    
    * lisp/dired.el (dired-move-to-filename): Document the parameters
    (bug#17566).
---
 lisp/dired.el | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lisp/dired.el b/lisp/dired.el
index efe00d1..6e48d28 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)