From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#18201: 24.4.50; doc string of `file-accessible-directory-p' Date: Sat, 30 Apr 2016 01:25:33 +0200 Message-ID: <87bn4sknf6.fsf@gnus.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461972403 2494 80.91.229.3 (29 Apr 2016 23:26:43 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 29 Apr 2016 23:26:43 +0000 (UTC) Cc: 18201@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 01:26:31 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 1awHnr-0005IF-Gn for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 01:26:31 +0200 Original-Received: from localhost ([::1]:56772 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHnn-0008Jv-DQ for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 19:26:27 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50404) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHne-00084M-3g for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 19:26:24 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awHnS-0008E9-50 for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 19:26:12 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:43853) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awHnS-0008Bk-1n for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 19:26:06 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awHnO-0004ZG-JJ for bug-gnu-emacs@gnu.org; Fri, 29 Apr 2016 19:26:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 29 Apr 2016 23:26:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 18201 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 18201-submit@debbugs.gnu.org id=B18201.146197233917527 (code B ref 18201); Fri, 29 Apr 2016 23:26:02 +0000 Original-Received: (at 18201) by debbugs.gnu.org; 29 Apr 2016 23:25:39 +0000 Original-Received: from localhost ([127.0.0.1]:56190 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awHn1-0004Yd-4Y for submit@debbugs.gnu.org; Fri, 29 Apr 2016 19:25:39 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:51935) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awHmz-0004YV-0h for 18201@debbugs.gnu.org; Fri, 29 Apr 2016 19:25:37 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awHmv-0004FT-TE; Sat, 30 Apr 2016 01:25:36 +0200 In-Reply-To: (Drew Adams's message of "Tue, 5 Aug 2014 12:13:22 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) 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:117297 Archived-At: Drew Adams writes: > 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'. No, it does return precisely t. Perhaps later it'll return other values. > 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). Fixed. > 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. Hm... I don't know what the doc string means here. And looking at the code, I still don't understand. Anybody? > 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. Fixed. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no