From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#18318: 24.4.50; doc of `file-readable-p' Date: Sat, 30 Apr 2016 08:07:31 -0800 (GMT-08:00) Message-ID: <1e419547-674b-4a83-aff5-8ed9437894ef@default> References: <630013e6-ced6-4849-90a4-2766b73bdf2f@default> <87bn4rrzb3.fsf@gnus.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1462032526 17853 80.91.229.3 (30 Apr 2016 16:08:46 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Apr 2016 16:08:46 +0000 (UTC) Cc: 18318@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 18:08:32 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1awXRW-0000wA-PS for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 18:08:30 +0200 Original-Received: from localhost ([::1]:58905 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awXRS-0002CL-Qc for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 12:08:26 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:38723) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awXRJ-0001xZ-98 for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 12:08:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awXR7-00015p-H9 for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 12:08:11 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:45727) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awXR7-00013i-EK for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 12:08:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awXR4-0001NZ-42 for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 12:08:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Apr 2016 16:08:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 18318 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: wontfix Original-Received: via spool by 18318-submit@debbugs.gnu.org id=B18318.14620324615268 (code B ref 18318); Sat, 30 Apr 2016 16:08:02 +0000 Original-Received: (at 18318) by debbugs.gnu.org; 30 Apr 2016 16:07:41 +0000 Original-Received: from localhost ([127.0.0.1]:58063 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awXQj-0001Mu-8i for submit@debbugs.gnu.org; Sat, 30 Apr 2016 12:07:41 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:19577) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awXQi-0001Mb-1Y for 18318@debbugs.gnu.org; Sat, 30 Apr 2016 12:07:40 -0400 Original-Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u3UG7Y5M023392 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sat, 30 Apr 2016 16:07:34 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by userv0022.oracle.com (8.14.4/8.13.8) with ESMTP id u3UG7XYq029803 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sat, 30 Apr 2016 16:07:34 GMT Original-Received: from abhmp0019.oracle.com (abhmp0019.oracle.com [141.146.116.25]) by aserv0121.oracle.com (8.13.8/8.13.8) with ESMTP id u3UG7WpO019496; Sat, 30 Apr 2016 16:07:33 GMT In-Reply-To: <87bn4rrzb3.fsf@gnus.org> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6744.5000 (x86)] X-Source-IP: userv0022.oracle.com [156.151.31.74] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:117369 Archived-At: > > The doc - both Elisp manual and doc string, should explicitly point out > > that this returns non-nil for a directory, IOW, a non-nil value does no= t > > mean that the file can be, say, inserted into a buffer. > > > > In addition, it would be better to change the parameter name to > > FILE-OR-DIR (or even FILE-OR-DIR-NAME). It is all to easy to not > > realize, when reading this, that this does not test for a non-directory > > file that is readable. >=20 > Well, the function isn't about files or directories, but filenames. It > can be a fifo, a device node, etc. All the more reason to make the doc clearer. The argument passed to the function is not necessarily the name of a file whose contents can, say, be inserted into a buffer. It is not a FILENAME, unless you understand "filename" in the wider sense you elaborated - elaboration that is missing from this doc. It is (I think) far more common for a file or directory name (string) to be passed as an argument than it is for a FIFO, device node, etc. to be passed. The directory case is common, and the doc misleads. If you want to mention other possibilities, besides file and dir names, so much the better. But ideal should not be the enemy of better. > So I think the doc is fine as it is. Disagree.