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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Arun Isaac <arunisaac <at> systemreboot.net>
Subject: bug#40202: closed (Re: bug#40202: directory-files-recursively
 docstring unclear about include-directories)
Date: Wed, 25 Mar 2020 19:58:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#40202: directory-files-recursively docstring unclear about include-directories

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 40202 <at> debbugs.gnu.org.

-- 
40202: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=40202
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Arun Isaac <arunisaac <at> systemreboot.net>
Cc: larsi <at> gnus.org, tomasn <at> posteo.net, 40202-done <at> debbugs.gnu.org
Subject: Re: bug#40202: directory-files-recursively docstring unclear about
 include-directories
Date: Wed, 25 Mar 2020 21:57:16 +0200

> From: Arun Isaac <arunisaac <at> systemreboot.net>
> Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, Eli Zaretskii <eliz <at> gnu.org>
> 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.

[Message part 3 (message/rfc822, inline)]

From: Arun Isaac <arunisaac <at> systemreboot.net>
To: bug-gnu-emacs <at> gnu.org
Subject: directory-files-recursively docstring unclear about
 include-directories
Date: Tue, 24 Mar 2020 02:46:55 +0530

[Message part 4 (text/plain, inline)]

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 (application/pgp-signature, inline)]

Previous Next

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