bug#40202: closed (directory-files-recursively docstring unclear about include-directories)

[GNU bug Tracking System]

Your message dated Wed, 25 Mar 2020 21:57:16 +0200
with message-id <address@hidden>
and subject line Re: bug#40202: directory-files-recursively docstring unclear 
about include-directories
has caused the debbugs.gnu.org bug report #40202,
regarding directory-files-recursively docstring unclear about 
include-directories
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden.)


-- 
40202: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=40202
GNU Bug Tracking System
Contact address@hidden with problems

--- Begin Message --- Subject: directory-files-recursively docstring unclear about include-directories Date: Tue, 24 Mar 2020 02:46:55 +0530

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."

Thanks,
Arun

signature.asc
Description: PGP signature

--- End Message ---

> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#40202: directory-files-recursively docstring unclear about include-directories
>
>
>
>
> Date: 
>
> Wed, 25 Mar 2020 21:57:16 +0200
>
>
>
>
> > From: Arun Isaac <address@hidden>
> > Cc: Lars Ingebrigtsen <address@hidden>, Eli Zaretskii <address@hidden>
> > Date: Thu, 26 Mar 2020 01:08:20 +0530
> > 
> > > Or a more prompting style
> > >
> > > "If INCLUDE-DIRECTORIES is non-nil, also include directories whose names
> > > matches REGEXP in the returned list."
> > 
> > I did consider this style. But, it is slightly harder to parse. For
> > example, it is easy to misparse the sentence as "also include
> > directories (whose names match REGEXP in the returned list)" when the
> > correct parsing should be "also include (directories whose names match
> > REGEXP) in the returned list".
>
> IME, if some text causes parsing difficulties, it is best dropped
> altogether, especially if it is redundant.  So that's what I did, see
> the emacs-27 branch.
>
> And with that, I'm closing this bug.  Thanks for pointing out the
> ambiguity of the original text.
>
>
> --- End Message ---