all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 18201@debbugs.gnu.org
Subject: bug#18201: 24.4.50; doc string of `file-accessible-directory-p'
Date: Tue, 5 Aug 2014 12:13:22 -0700 (PDT)	[thread overview]
Message-ID: <c547d0b1-6866-4351-946a-dec5a26cecc9@default> (raw)

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=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''





             reply	other threads:[~2014-08-05 19:13 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-05 19:13 Drew Adams [this message]
2016-04-29 23:25 ` bug#18201: 24.4.50; doc string of `file-accessible-directory-p' Lars Ingebrigtsen
2021-05-29  4:02   ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c547d0b1-6866-4351-946a-dec5a26cecc9@default \
    --to=drew.adams@oracle.com \
    --cc=18201@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.