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

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Reported by: Arun Isaac <arunisaac@HIDDEN>; dated Mon, 23 Mar 2020 21:18:01 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at 40202 <at> debbugs.gnu.org:


Received: (at 40202) by debbugs.gnu.org; 25 Mar 2020 17:20:20 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Wed Mar 25 13:20:20 2020
Received: from localhost ([127.0.0.1]:57691 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1jH9hT-00008a-MQ
	for submit <at> debbugs.gnu.org; Wed, 25 Mar 2020 13:20:19 -0400
Received: from mout01.posteo.de ([185.67.36.65]:40067)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <tomasn@HIDDEN>) id 1jH9hQ-00008C-HG
 for 40202 <at> debbugs.gnu.org; Wed, 25 Mar 2020 13:20:18 -0400
Received: from submission (posteo.de [89.146.220.130]) 
 by mout01.posteo.de (Postfix) with ESMTPS id C7EDB160060
 for <40202 <at> debbugs.gnu.org>; Wed, 25 Mar 2020 18:20:09 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017;
 t=1585156809; bh=MiZ95WmOR63Gnxveifs4u7lm/JLwGcLlhjYb8XXdLbM=;
 h=From:To:Subject:Date:From;
 b=N67+sSIFB2B5YAR6AxmU+YlHDX7mV2Gt2YVAUe32A99sMzNhmZeGJrQrWnphc4ghs
 sXg4RTbu5ZHNbyomlpZsAD59Ox9CxveRQY6FyfteyERwgCPiVEWC4vIGTBHpvTXY+c
 tpc3DJ1o6XZb4vhOAmao8QCR6VcsnQbuPIqpYKRqQCjRvICsUGTVzCcxM5V396St/c
 xxeaA1ySGTLAnu4lKLTIjCaR7GXjLXdObJyQYJa4/HDuCd9yHrzTRUKnl/Hk5pN2Ci
 6eOh6XhMsQWyxvV5YQybIxJ76Z2CXl/nVyc3h7Z07T/QwaqCykEsrm3qgYXhG0giGa
 kvH3GBnJp1FaQ==
Received: from customer (localhost [127.0.0.1])
 by submission (posteo.de) with ESMTPSA id 48nZcn0TY8z6tmZ;
 Wed, 25 Mar 2020 18:20:08 +0100 (CET)
From: Tomas Nordin <tomasn@HIDDEN>
To: Arun Isaac <arunisaac@HIDDEN>, 40202 <at> debbugs.gnu.org
Subject: Re: bug#40202: directory-files-recursively docstring unclear about
 include-directories
In-Reply-To: <cu7mu86vkjc.fsf@HIDDEN>
References: <cu7mu86vkjc.fsf@HIDDEN>
Date: Wed, 25 Mar 2020 18:20:06 +0100
Message-ID: <87blokl5bt.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: 40202
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

Arun Isaac <arunisaac@HIDDEN> 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




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#40202; Package emacs. Full text available.

Message received at 40202 <at> debbugs.gnu.org:


Received: (at 40202) by debbugs.gnu.org; 24 Mar 2020 21:23:25 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Mar 24 17:23:25 2020
Received: from localhost ([127.0.0.1]:55666 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1jGr1B-0005sY-32
	for submit <at> debbugs.gnu.org; Tue, 24 Mar 2020 17:23:25 -0400
Received: from quimby.gnus.org ([95.216.78.240]:51964)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <larsi@HIDDEN>) id 1jGr1A-0005sL-4P
 for 40202 <at> debbugs.gnu.org; Tue, 24 Mar 2020 17:23:24 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org;
 s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date:
 References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding:
 Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender:
 Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:
 List-Subscribe:List-Post:List-Owner:List-Archive;
 bh=ESFdx7XndGaJZcAeciwFg2q7WlrrBcSyGhzWPnZnO4M=; b=b5aXQoF8BTZd96stKl46c59AI9
 TQFk0M/zM/yhFcWzvNpGHKUxR9DDETmYqUHWFV6n3QRWokqvydMNTQ5G78a5t0O43jZUKWxWSCHt5
 gGXDC9HW8cfuL6JVzXLuyJNrow7SrDV3TnLBN5+Dql2I15nZAE2TqvyZd4BdHge2N3nQ=;
Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie)
 by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.92) (envelope-from <larsi@HIDDEN>)
 id 1jGr10-0006gP-N1; Tue, 24 Mar 2020 22:23:17 +0100
From: Lars Ingebrigtsen <larsi@HIDDEN>
To: Arun Isaac <arunisaac@HIDDEN>
Subject: Re: bug#40202: directory-files-recursively docstring unclear about
 include-directories
References: <cu7mu86vkjc.fsf@HIDDEN> <83blombfjk.fsf@HIDDEN>
 <cu7h7yeuppx.fsf@HIDDEN>
Date: Tue, 24 Mar 2020 22:23:14 +0100
In-Reply-To: <cu7h7yeuppx.fsf@HIDDEN> (Arun Isaac's message of "Tue, 
 24 Mar 2020 13:52:34 +0530")
Message-ID: <87v9mt4fct.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org",
 has NOT identified this incoming email as spam.  The original
 message has been attached to this so you can view it or label
 similar future email.  If you have any questions, see
 @@CONTACT_ADDRESS@@ for details.
 Content preview: Arun Isaac <arunisaac@HIDDEN> writes: > They seem
 equivalent once you already know the meaning that is supposed > to be
 conveyed.
 I had to wrack my brains for a while before I understood > what that sentence
 means. Content analysis details:   (-2.9 points, 5.0 required)
 pts rule name              description
 ---- ---------------------- --------------------------------------------------
 -1.0 ALL_TRUSTED            Passed through trusted hosts only via SMTP
 -1.9 BAYES_00               BODY: Bayes spam probability is 0 to 1%
 [score: 0.0000]
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 40202
Cc: Eli Zaretskii <eliz@HIDDEN>, 40202 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Arun Isaac <arunisaac@HIDDEN> writes:

> They seem equivalent once you already know the meaning that is supposed
> to be conveyed. I had to wrack my brains for a while before I understood
> what that sentence means.

Yes, I agree that your version is much clearer and easier to understand.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#40202; Package emacs. Full text available.

Message received at 40202 <at> debbugs.gnu.org:


Received: (at 40202) by debbugs.gnu.org; 24 Mar 2020 08:22:49 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Tue Mar 24 04:22:49 2020
Received: from localhost ([127.0.0.1]:53840 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1jGepl-00088u-6k
	for submit <at> debbugs.gnu.org; Tue, 24 Mar 2020 04:22:49 -0400
Received: from mugam.systemreboot.net ([139.59.75.54]:53068)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <arunisaac@HIDDEN>) id 1jGepi-00088k-GO
 for 40202 <at> debbugs.gnu.org; Tue, 24 Mar 2020 04:22:47 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed;
 d=systemreboot.net; s=default; h=Content-Type:MIME-Version:Message-ID:Date:
 References:In-Reply-To:Subject:Cc:To:From:Sender:Reply-To:
 Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date:
 Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:
 List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive;
 bh=Cuy4ox9B7rqoGWGUElCj5CHhQSBO1qsU3Mdsp8neKTY=; b=aZA1ICA7D+HRqSWUaf1wHBTXR
 /LBZmL/J5PuGgtO6RuUGRgGhAeM6YQBX+EfkmbzDckOFIlynJG23IYlXMZUKlsqSYUg6dUhJNhPrI
 t/ib1Ws4uH+pf9s6Bn+E4obU0brgl5kEjQHYdMIdexU4NpH8cNn/uQLNw1p0CLxMbgy4Y=;
Received: from [192.168.2.1] (helo=steel)
 by systemreboot.net with esmtpsa  (TLS1.3) tls TLS_AES_256_GCM_SHA384
 (Exim 4.93) (envelope-from <arunisaac@HIDDEN>)
 id 1jGepf-003rmH-Fn; Tue, 24 Mar 2020 13:52:43 +0530
From: Arun Isaac <arunisaac@HIDDEN>
To: Eli Zaretskii <eliz@HIDDEN>
Subject: Re: bug#40202: directory-files-recursively docstring unclear about
 include-directories
In-Reply-To: <83blombfjk.fsf@HIDDEN>
References: <cu7mu86vkjc.fsf@HIDDEN> <83blombfjk.fsf@HIDDEN>
Date: Tue, 24 Mar 2020 13:52:34 +0530
Message-ID: <cu7h7yeuppx.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-=";
 micalg=pgp-sha256; protocol="application/pgp-signature"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 40202
Cc: 40202 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

--=-=-=
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable


>> The docstring of directory-file-recursively in lisp/files.el is unclear
>> about the include-directories optional argument. It currently reads
>>=20
>> "Optional argument INCLUDE-DIRECTORIES non-nil means also include
>> in the output directories whose names match REGEXP."
>>=20
>> Perhaps this could be rewritten as
>>=20
>> "If optional argument INCLUDE-DIRECTORIES is non-nil, the returned list
>> also includes directories whose names match REGEXP."
>
> Could you please explain which part(s) of the proposed doc string make
> the issue more clear for you?  To me both variants sound equivalent.

They seem equivalent once you already know the meaning that is supposed
to be conveyed. I had to wrack my brains for a while before I understood
what that sentence means.

1. It is not immediately clear how to parse the original docstring. Is
it parsed as "(include) (in the output directories whose name matches
REGEXP)", "(include in the output directories) (whose name matches
REGEXP)" or "(include in the output) (directories whose name matches
REGEXP)"? The phrase "in the output" in between the sentence makes it
difficult to parse. Some punctuation there could have helped, but I
don't see how to do that.

2. The grammar of my proposal is better. In the original, the usage of
"means" as the predicate, "optional argument INCLUDE-DIRECTORIES
non-nil" as the subject is unusual and awkward.

--=-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEf3MDQ/Lwnzx3v3nTLiXui2GAK7MFAl55w0oACgkQLiXui2GA
K7PhDggAqvTYXO25D39/c17i9bpSFvixnNbK4dzm61TQ4dZGyEoL7q9rOB8pAoV2
GN8llr+uuCbCPSI/SwrxKILBIfxMCRKcDI6CvPjzGynfSJWSR2IPBsEOgio392ft
RS9LmvR2QPCwI74wRBBryOwNXa3NqU5cSHC85iO/Xkp5rjrndCz5XbLnrrI+spEt
uP7tIjRKO5bM6ZgKmDQgfmyVjiLyh7Ztic8HXKtCsK1fuy664UREe2nEeEGjakPD
IruykmfMnWRevMZTP8+5r9ZFAQkz4v5Lv4IRw4rI4ca4+sLQUqV6IFO5VXYX71Nm
zS9MGgFT8ECeVRw0n5BBay7323RWrQ==
=1c5O
-----END PGP SIGNATURE-----
--=-=-=--




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#40202; Package emacs. Full text available.

Message received at 40202 <at> debbugs.gnu.org:


Received: (at 40202) by debbugs.gnu.org; 24 Mar 2020 03:25:05 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Mar 23 23:25:05 2020
Received: from localhost ([127.0.0.1]:53734 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1jGaBc-00006U-05
	for submit <at> debbugs.gnu.org; Mon, 23 Mar 2020 23:25:04 -0400
Received: from eggs.gnu.org ([209.51.188.92]:35283)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <eliz@HIDDEN>) id 1jGaBZ-00005l-Eb
 for 40202 <at> debbugs.gnu.org; Mon, 23 Mar 2020 23:25:02 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e]:40425)
 by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <eliz@HIDDEN>)
 id 1jGaBT-0000hY-IZ; Mon, 23 Mar 2020 23:24:55 -0400
Received: from [176.228.60.248] (port=4656 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256)
 (Exim 4.82) (envelope-from <eliz@HIDDEN>)
 id 1jGaBS-0004mG-UZ; Mon, 23 Mar 2020 23:24:55 -0400
Date: Tue, 24 Mar 2020 05:25:03 +0200
Message-Id: <83blombfjk.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
To: Arun Isaac <arunisaac@HIDDEN>
In-Reply-To: <cu7mu86vkjc.fsf@HIDDEN> (message from Arun Isaac on
 Tue, 24 Mar 2020 02:46:55 +0530)
Subject: Re: bug#40202: directory-files-recursively docstring unclear about
 include-directories
References: <cu7mu86vkjc.fsf@HIDDEN>
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]
X-Spam-Score: -0.7 (/)
X-Debbugs-Envelope-To: 40202
Cc: 40202 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.7 (-)

> From: Arun Isaac <arunisaac@HIDDEN>
> Date: Tue, 24 Mar 2020 02:46:55 +0530
> 
> 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."

Could you please explain which part(s) of the proposed doc string make
the issue more clear for you?  To me both variants sound equivalent.




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#40202; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 23 Mar 2020 21:17:21 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Mar 23 17:17:21 2020
Received: from localhost ([127.0.0.1]:53629 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1jGURl-0007aZ-8F
	for submit <at> debbugs.gnu.org; Mon, 23 Mar 2020 17:17:21 -0400
Received: from lists.gnu.org ([209.51.188.17]:41805)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <arunisaac@HIDDEN>) id 1jGURj-0007aR-55
 for submit <at> debbugs.gnu.org; Mon, 23 Mar 2020 17:17:19 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10]:36024)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <arunisaac@HIDDEN>) id 1jGURh-0007cW-Dm
 for bug-gnu-emacs@HIDDEN; Mon, 23 Mar 2020 17:17:19 -0400
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,URIBL_BLOCKED
 autolearn=disabled version=3.3.2
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <arunisaac@HIDDEN>) id 1jGURf-0003TY-Nl
 for bug-gnu-emacs@HIDDEN; Mon, 23 Mar 2020 17:17:16 -0400
Received: from mugam.systemreboot.net ([139.59.75.54]:55836)
 by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)
 (Exim 4.71) (envelope-from <arunisaac@HIDDEN>)
 id 1jGURe-0003Sn-J6
 for bug-gnu-emacs@HIDDEN; Mon, 23 Mar 2020 17:17:15 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed;
 d=systemreboot.net; s=default; h=Content-Type:MIME-Version:Message-ID:Date:
 Subject:To:From:Sender:Reply-To:Cc:Content-Transfer-Encoding:Content-ID:
 Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc
 :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe:
 List-Subscribe:List-Post:List-Owner:List-Archive;
 bh=V77kL8/VATz5uIMI3DD3lvP9zZLEmT5ShkQVTBW0mfs=; b=I2sL2cgNib4IM9+Jpu4VhFvrBd
 er1VGBBxeoSWK48MsXjtFWrNq6GOECztO9S+yiiCoN8+yX8ghHFD0QYu1i7uhWtRthIIYselFyh0Q
 //fb9MbTgaI5Wy4hKSxhZ+7pKUAZql/6j4izyD64F4i2TGrzPJlzzrlaVr39onHA0OIA=;
Received: from [192.168.2.1] (helo=steel)
 by systemreboot.net with esmtpsa  (TLS1.3) tls TLS_AES_256_GCM_SHA384
 (Exim 4.93) (envelope-from <arunisaac@HIDDEN>)
 id 1jGURZ-003pkk-Rg
 for bug-gnu-emacs@HIDDEN; Tue, 24 Mar 2020 02:47:09 +0530
From: Arun Isaac <arunisaac@HIDDEN>
To: bug-gnu-emacs@HIDDEN
Subject: directory-files-recursively docstring unclear about
 include-directories
Date: Tue, 24 Mar 2020 02:46:55 +0530
Message-ID: <cu7mu86vkjc.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-=";
 micalg=pgp-sha256; protocol="application/pgp-signature"
X-detected-operating-system: by eggs.gnu.org: Genre and OS details not
 recognized.
X-Received-From: 139.59.75.54
X-Spam-Score: 0.2 (/)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.8 (/)

--=-=-=
Content-Type: text/plain


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

--=-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEf3MDQ/Lwnzx3v3nTLiXui2GAK7MFAl55J0cACgkQLiXui2GA
K7OLRAf/X/2eO2bNpmVuiaWJ6dv6h4qWR0uIPXWVSss+LgCvvVixlDGwXEwVoaau
bpoBHk5biELKq/TLMH27p2Tpx6smlrVgKAAVbq0gpNbNCKlJ27FvrbiMl5yKtJO6
Wq07qOeAmvTXJZBQ1pYin0F5VGgsbUYNYS9KSYWUmkOHhTaBggKnCeKUNdEMgLCk
M+Ykzud/3WDyFQB6A4Yz/HrxiKI+YR0LUQzVYWXKaIv+NRkdOF2qRPd10pIpcGY4
WFpuVWY1p7t35wfQvhRn+W8AkliLlg41RUpoooOgRCI6Fh76Obp81GVmRUCJmofi
2JhJqdC0jn/izkvFkK9g4HD4IpElfg==
=HYPy
-----END PGP SIGNATURE-----
--=-=-=--




Acknowledgement sent to Arun Isaac <arunisaac@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#40202; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Wed, 25 Mar 2020 17:30:01 UTC

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