GNU bug report logs - #40202
directory-files-recursively docstring unclear about include-directories

Previous Next

Full log

Message #17 received at 40202 <at> debbugs.gnu.org (full text, mbox):

From: Tomas Nordin <tomasn <at> posteo.net>
To: Arun Isaac <arunisaac <at> systemreboot.net>, 40202 <at> debbugs.gnu.org
Subject: Re: bug#40202: directory-files-recursively docstring unclear about
 include-directories
Date: Wed, 25 Mar 2020 18:20:06 +0100

Arun Isaac <arunisaac <at> systemreboot.net> writes:

> Hi,
>
> The docstring of directory-file-recursively in lisp/files.el is unclear
> about the include-directories optional argument. It currently reads
>
> "Optional argument INCLUDE-DIRECTORIES non-nil means also include
> in the output directories whose names match REGEXP."
>
> Perhaps this could be rewritten as
>
> "If optional argument INCLUDE-DIRECTORIES is non-nil, the returned list
> also includes directories whose names match REGEXP."

Or a more prompting style

"If INCLUDE-DIRECTORIES is non-nil, also include directories whose names
matches REGEXP in the returned list."

I think it is not necessary to repeat that the argument is optional, but
maybe that is standard.

?

Best regards
--
Tomas

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.