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#18201: 24.4.50; doc string of `file-accessible-directory-p' Date: Tue, 5 Aug 2014 12:13:22 -0700 (PDT) Message-ID: 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 1407266139 30157 80.91.229.3 (5 Aug 2014 19:15:39 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 5 Aug 2014 19:15:39 +0000 (UTC) To: 18201@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Aug 05 21:15:31 2014 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 1XEkCn-0001Ng-OX for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Aug 2014 21:15:29 +0200 Original-Received: from localhost ([::1]:33088 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkCn-0001T3-A9 for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Aug 2014 15:15:29 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60010) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkCX-0001Rf-Mj for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:15:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEkCN-00032J-Cf for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:15:13 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:52242) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkCN-00031g-93 for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:15:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XEkCM-0001jw-HP for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:15: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: Tue, 05 Aug 2014 19:15:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 18201 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.14072660426578 (code B ref -1); Tue, 05 Aug 2014 19:15:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 5 Aug 2014 19:14:02 +0000 Original-Received: from localhost ([127.0.0.1]:59184 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XEkBO-0001i2-3L for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:14:02 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:58119) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XEkBM-0001hR-1D for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:14:00 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEkB6-0002p3-IP for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:13:54 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:42961) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkB6-0002oz-Fc for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:13:44 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:59806) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkAx-0000VQ-MG for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:13:44 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEkAo-0002nB-VX for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:13:35 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:32164) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkAo-0002n6-PN for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:13:26 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s75JDPBv008707 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 5 Aug 2014 19:13:25 GMT Original-Received: from aserz7022.oracle.com (aserz7022.oracle.com [141.146.126.231]) by ucsinet22.oracle.com (8.14.5+Sun/8.14.5) with ESMTP id s75JDOmN025953 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 5 Aug 2014 19:13:24 GMT Original-Received: from abhmp0005.oracle.com (abhmp0005.oracle.com [141.146.116.11]) by aserz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s75JDN6i012178 for ; Tue, 5 Aug 2014 19:13:23 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6691.5000 (x86)] X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:92156 Archived-At: The doc string: Return t if file FILENAME names a directory you can open. For the value to be t, FILENAME must specify the name of a directory as a = file, and the directory must allow you to open files in it. In order to use a directory as a buffer's current directory, this predicate must return true= . A directory name spec may be given instead; then the value is t if the directory so specified exists and really is a readable and searchable directory. 1. Unless other non-nil values can be returned, in which case they need to be documented, the doc should refer to "non-nil" (or "true"), not to `t'. 2. "Return t if file FILENAME names a directory..." is wrong. It should say just "FILENAME", not "file FILENAME". A file does not name anything. A file name names something (in this case, a directory). #1 and #2 are problems for other, related doc strings, as well. Presumably someone renamed the parameter from FILE to FILENAME without adapting the doc string properly (?). 3. The biggest problem with this doc string is that it refers to something called a "directory name spec", without either (1) saying what that is or (2) telling you where to find this information. You CANNOT understand this doc string without knowing what "directory name spec" means. 4. The lines of text should not be longer than 70 chars (except the first, which can be a little longer. The second line is 79 chars. Please fill all but the first line. In GNU Emacs 24.4.50.1 (i686-pc-mingw32) of 2014-06-28 on ODIEONE Bzr revision: 117431 rgm@gnu.org-20140628015517-eku6hj8mpgcvfnso Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --prefix=3D/c/Devel/emacs/snapshot/trunk --enable-checking=3Dyes,glyphs 'CFLAGS=3D-O0 -g3' LDFLAGS=3D-Lc:/Devel/emacs/lib 'CPPFLAGS=3D-DGC_MCHECK=3D1 -Ic:/Devel/emacs/include''