Clarify doc string of 'dired-current-directory'

* lisp/dired.el (dired-current-directory): Doc fix: clarify that
the return value might not end in a slash when called with the
optional argument non-nil.  (Bug#6273)
This commit is contained in:
Eli Zaretskii 2016-01-08 12:40:14 +02:00
parent e990bb270e
commit 30abf295e8

View file

@ -2806,7 +2806,9 @@ It runs the hook `dired-initial-position-hook'."
(defun dired-current-directory (&optional localp)
"Return the name of the subdirectory to which this line belongs.
This returns a string with trailing slash, like `default-directory'.
Optional argument means return a file name relative to `default-directory'."
Optional argument means return a file name relative to `default-directory',
in which case the value could be an empty string if `default-directory'
is the directory where the file on this line resides."
(let ((here (point))
(alist (or dired-subdir-alist
;; probably because called in a non-dired buffer