emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

emacs-27 e1f0e08: * lisp/files.el (directory-files-recursively): Doc fix


From: Eli Zaretskii
Subject: emacs-27 e1f0e08: * lisp/files.el (directory-files-recursively): Doc fix. (Bug#40202)
Date: Wed, 25 Mar 2020 15:55:33 -0400 (EDT)

branch: emacs-27
commit e1f0e0892232221e6333b24788b97942c83ec738
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    * lisp/files.el (directory-files-recursively): Doc fix.  (Bug#40202)
---
 lisp/files.el | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/lisp/files.el b/lisp/files.el
index 38536a9..01da2a9 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -819,23 +819,25 @@ The path separator is colon in GNU and GNU-like systems."
 (defun directory-files-recursively (dir regexp
                                         &optional include-directories predicate
                                         follow-symlinks)
-  "Return list of all files under DIR that have file names matching REGEXP.
+  "Return list of all files under directory DIR whose names match REGEXP.
 This function works recursively.  Files are returned in \"depth
 first\" order, and files from each directory are sorted in
 alphabetical order.  Each file name appears in the returned list
 in its absolute form.
 
-Optional argument INCLUDE-DIRECTORIES non-nil means also include
-in the output directories whose names match REGEXP.
+By default, the returned list excludes directories, but if
+optional argument INCLUDE-DIRECTORIES is non-nil, they are
+included.
 
 PREDICATE can be either nil (which means that all subdirectories
-are descended into), t (which means that subdirectories that
+of DIR are descended into), t (which means that subdirectories that
 can't be read are ignored), or a function (which is called with
-the name of the subdirectory and should return non-nil if the
+the name of each subdirectory, and should return non-nil if the
 subdirectory is to be descended into).
 
-If FOLLOW-SYMLINKS, symbolic links that point to directories are
-followed.  Note that this can lead to infinite recursion."
+If FOLLOW-SYMLINKS is non-nil, symbolic links that point to
+directories are followed.  Note that this can lead to infinite
+recursion."
   (let* ((result nil)
         (files nil)
          (dir (directory-file-name dir))



reply via email to

[Prev in Thread] Current Thread [Next in Thread]