all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stephen Berman <stephen.berman@gmx.net>
Cc: 23937@debbugs.gnu.org
Subject: bug#23937: 25.0.95; Search functions doc fixes/improvements
Date: Tue, 12 Jul 2016 08:03:25 +0300	[thread overview]
Message-ID: <834m7vcusi.fsf@gnu.org> (raw)
In-Reply-To: <871t2z262g.fsf@gmx.net> (message from Stephen Berman on Mon, 11 Jul 2016 23:55:19 +0200)

> From: Stephen Berman <stephen.berman@gmx.net>
> Cc: 23937@debbugs.gnu.org
> Date: Mon, 11 Jul 2016 23:55:19 +0200
> 
> >> @@ -2247,14 +2252,15 @@ DEFUN ("posix-search-backward", Fposix_search_backward, Sposix_search_backward,
> >>         "sPosix search backward: ",
> >>         doc: /* Search backward from point for match for regular expression REGEXP.
> >>  Find the longest match in accord with Posix regular expression rules.
> >> -Set point to the beginning of the match, and return point.
> >> -The match found is the one starting last in the buffer
> >> -and yet ending before the origin of the search.
> >> +Set point to the beginning of the occurrence found, and return point.
> >
> > The 2nd and 3rd lines you removed seem to provide valuable information
> > which is now gone, no?
> 
> I removed them because I thought they were (i) partly redundant: the
> first words of the doc string, "Search backward from point", already
> imply that the match ends before that position, since otherwise it
> wouldn't be a search backward

I don't agree, I think this part is not clear unless explicitly
described.  I frequently find myself wondering about this when I
need to code a loop that uses these functions.

> and (ii) partly inaccurate: saying the
> match found is the last one in the buffer before the starting point is
> only true when COUNT is 1 (or nil)

Then let's make it more accurate, but I don't think removing that is
TRT.  In particular, there's nothing wrong with describing what
happens with COUNT = 1 if the clarity is required only in that case.

> I assume it's ok to push the changes to emacs-25?

Yes.

(The comment about COUNT = 0 was a teaser, don't worry about that.)





  reply	other threads:[~2016-07-12  5:03 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-10 18:21 bug#23937: 25.0.95; Search functions doc fixes/improvements Stephen Berman
2016-07-11 15:20 ` Eli Zaretskii
2016-07-11 21:55   ` Stephen Berman
2016-07-12  5:03     ` Eli Zaretskii [this message]
2016-07-12 12:26       ` Stephen Berman
2016-07-12 13:10         ` Eli Zaretskii
2016-07-12 15:14           ` Stephen Berman
2016-07-12 15:23             ` Eli Zaretskii
2016-07-12 20:13               ` Stephen Berman

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=834m7vcusi.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=23937@debbugs.gnu.org \
    --cc=stephen.berman@gmx.net \
    /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.