summaryrefslogtreecommitdiff
path: root/doc/lispref/files.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-07-04 14:59:58 +0300
committerEli Zaretskii <eliz@gnu.org>2022-07-04 14:59:58 +0300
commit603de9a38ef92bb6583973e6c874f551c185d3bd (patch)
tree2e55485eaab1077a81fd5eb31c0e6e2ceb5eabcf /doc/lispref/files.texi
parent1ac383bcb69578ac9e89ab00538d81ee8daee022 (diff)
downloademacs-603de9a38ef92bb6583973e6c874f551c185d3bd.tar.gz
emacs-603de9a38ef92bb6583973e6c874f551c185d3bd.tar.bz2
emacs-603de9a38ef92bb6583973e6c874f551c185d3bd.zip
; Fix documentation of 'file-parent-directory'
* doc/lispref/files.texi (Directory Names): * lisp/files.el (file-parent-directory): Improve wording of the documentation of 'file-parent-directory'. (Bug#56355)
Diffstat (limited to 'doc/lispref/files.texi')
-rw-r--r--doc/lispref/files.texi9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index ee4e1ec4d96..986fb22c75b 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -2446,9 +2446,12 @@ because it recognizes abbreviations even as part of the name.
@end defun
@defun file-parent-directory filename
-This function returns the parent directory of @var{filename}. If
-@var{filename} is at the top level, return @code{nil}. @var{filename}
-can be relative to @code{default-directory}.
+This function returns the directory name of the parent directory of
+@var{filename}. If @var{filename} is at the root directory of the
+filesystem, it returns @code{nil}. A relative @var{filename} is
+assumed to be relative to @code{default-directory}, and the return
+value will also be relative in that case. If the return value is
+non-@code{nil}, it ends in a slash.
@end defun
@node File Name Expansion