From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 18201@debbugs.gnu.org
Subject: bug#18201: 24.4.50; doc string of `file-accessible-directory-p'
Date: Sat, 30 Apr 2016 01:25:33 +0200 [thread overview]
Message-ID: <87bn4sknf6.fsf@gnus.org> (raw)
In-Reply-To: <c547d0b1-6866-4351-946a-dec5a26cecc9@default> (Drew Adams's message of "Tue, 5 Aug 2014 12:13:22 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> 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
next prev parent reply other threads:[~2016-04-29 23:25 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-05 19:13 bug#18201: 24.4.50; doc string of `file-accessible-directory-p' Drew Adams
2016-04-29 23:25 ` Lars Ingebrigtsen [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87bn4sknf6.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=18201@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).