]> code.delx.au - gnu-emacs/commitdiff
Clarify doc string of 'dired-current-directory'
authorEli Zaretskii <eliz@gnu.org>
Fri, 8 Jan 2016 10:40:14 +0000 (12:40 +0200)
committerEli Zaretskii <eliz@gnu.org>
Fri, 8 Jan 2016 10:40:14 +0000 (12:40 +0200)
* 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)

lisp/dired.el

index 5b5b6f073dff2855419a12e19084d5cd4b27d444..e023da27be36fd91de951e4dd9a17dd32d45fdd2 100644 (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