From: Drew Adams <drew.adams@oracle.com>
To: 18202@debbugs.gnu.org
Subject: bug#18202: 24.4.50; doc string of `next-error-buffer-p'
Date: Tue, 5 Aug 2014 12:52:03 -0700 (PDT) [thread overview]
Message-ID: <f980a263-d7b2-4091-bf07-f12fe5509859@default> (raw)
The doc string:
Test if BUFFER is a `next-error' capable buffer.
If AVOID-CURRENT is non-nil, treat the current buffer
as an absolute last resort only.
The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
that normally would not qualify. If it returns t, the buffer
in question is treated as usable.
The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
that would normally be considered usable. If it returns nil,
that buffer is rejected.
The doc string is very poor.
1. The first line should say that the predicate returns non-nil if
BUFFER is a `next-error'-capable buffer.
2. The doc string should then give some indication of what that means
(what it means for a buffer to be `next-error'-capable).
3. The description of AVOID-CURRENT says nothing. It needs to say what
the behavior is and how it affects the return value (if it does).
"Treat the buffer" means nothing here, as does "as a last resort."
4. The other two paragraphs: What does it mean (a) for a buffer to
"qualify" or "normally be considered usable" ("normally"? What does
that mean here?), and (b) for a buffer to be "usable" or "rejected"?
Again, this text says nothing helpful. It should say what the
behavior is.
Presumably, the last sentence in each of these paragraphs should say
"If it returns [t|nil] then so does `next-error-buffer-p'."
There really is nothing good about this doc string.
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''
next reply other threads:[~2014-08-05 19:52 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-05 19:52 Drew Adams [this message]
2016-04-30 0:02 ` bug#18202: 24.4.50; doc string of `next-error-buffer-p' 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=f980a263-d7b2-4091-bf07-f12fe5509859@default \
--to=drew.adams@oracle.com \
--cc=18202@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.