From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 18202@debbugs.gnu.org
Subject: bug#18202: 24.4.50; doc string of `next-error-buffer-p'
Date: Sat, 30 Apr 2016 02:02:03 +0200 [thread overview]
Message-ID: <8737q4klqc.fsf@gnus.org> (raw)
In-Reply-To: <f980a263-d7b2-4091-bf07-f12fe5509859@default> (Drew Adams's message of "Tue, 5 Aug 2014 12:52:03 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> writes:
> 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.
Fixed.
> 2. The doc string should then give some indication of what that means
> (what it means for a buffer to be `next-error'-capable).
Hm... No I think that's pretty evident. It's a buffer in which the
command `next-error' makes sense.
> 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."
Yes, that's odd. Looking at the code, it just means that it returns nil
if given and BUFFER is the current buffer. Fixed.
> 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'."
Fixed.
> There really is nothing good about this doc string.
It's an almost verbatim copy of the doc string from
`next-error-find-buffer', which explains why it's so odd.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
prev parent reply other threads:[~2016-04-30 0:02 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-05 19:52 bug#18202: 24.4.50; doc string of `next-error-buffer-p' Drew Adams
2016-04-30 0:02 ` Lars Ingebrigtsen [this message]
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=8737q4klqc.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=18202@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 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.