unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Stefan Monnier'" <monnier@iro.umontreal.ca>
Cc: 10507@debbugs.gnu.org
Subject: bug#10507: 24.0.92; Doc of `search-forward' (and backward)
Date: Mon, 16 Jan 2012 06:51:16 -0800	[thread overview]
Message-ID: <4F0FFFB47E574B9D9DF35AD518F331AC@us.oracle.com> (raw)
In-Reply-To: <jwvaa5n91wl.fsf-monnier+emacs@gnu.org>

> > Furthermore, the doc says explicitly that the 4th arg MUST 
> > BE POSITIVE.  That is no only NOT the case, it is even the
> > case that the Emacs lisp code uses a negative value as the
> > 4th arg.  See, e.g., `zap-to-char'.
> 
> "MUST BE POSITIVE" doesn't mean that a negative argument will
> be rejected.  So the doc is perfectly allowed to say "MUST BE 
> POSITIVE" even if the code handles negative values (it just
> means that negative values are "NOT SUPPORTED").  And if some
> core code uses negative values, that's a naughty breach of
> abstraction, but that's about it.

Words, even words like "must", can always be somewhat ambiguous.  But "must"
generally implies some sort of enforcement or negative consequences if not
respected.

"Should" is typically used when something is recommended but not prohibited or
enforced.  And if you say nothing at all about positive/non-positive then, as
you are wont to say, "all bets are off" - no statement about support, the user
knows nothing.

I think that most readers would expect in this case ("must") that an error is
raised if the arg is not positive - or at least that the function becomes a
no-op.

Compare the doc for `/': "The arguments must be numbers or markers."

> So I see no bug here.  If you want a change, please say which and why.

A negative arg is supported by the code; it is used by Emacs source code; and it
is useful.  Knowing about it will mean simpler code by users.  Please document
(and support) it.  Thx.






  reply	other threads:[~2012-01-16 14:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-01-14 22:37 bug#10507: 24.0.92; Doc of `search-forward' (and backward) Drew Adams
2012-01-16 14:10 ` Stefan Monnier
2012-01-16 14:51   ` Drew Adams [this message]
2012-01-16 15:21     ` Stefan Monnier
2012-01-26 15:48     ` Chong Yidong

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=4F0FFFB47E574B9D9DF35AD518F331AC@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=10507@debbugs.gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).