From: Stephen Berman <stephen.berman@gmx.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 23937@debbugs.gnu.org, Stephen Berman <stephen.berman@gmx.net>
Subject: bug#23937: 25.0.95; Search functions doc fixes/improvements
Date: Tue, 12 Jul 2016 17:14:19 +0200 [thread overview]
Message-ID: <877fcqanxw.fsf@rub.de> (raw)
In-Reply-To: <83mvlnatob.fsf@gnu.org> (Eli Zaretskii's message of "Tue, 12 Jul 2016 16:10:28 +0300")
On Tue, 12 Jul 2016 16:10:28 +0300 Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Stephen Berman <stephen.berman@gmx.net>
>> Cc: 23937@debbugs.gnu.org
>> Date: Tue, 12 Jul 2016 14:26:12 +0200
>>
>> Set point to the beginning of the occurrence found, and return point.
>> An optional second argument bounds the search; it is a buffer position.
>> The match found must start at or after that position. A value of nil
>> means search to the beginning of the accessible portion of the buffer.
>> Optional third argument, if t, means if fail just return nil (no error).
>> If not nil and not t, move to limit of search and return nil.
>> Optional fourth argument COUNT, if a positive number, means to search
>> for COUNT successive occurrences. If COUNT is negative, search
>> forward, instead of backward, for -COUNT occurrences. A value of
>> nil means the same as 1.
>> The match found is the COUNTth to last one (or last, if COUNT is 1 or
>> nil) in the buffer located entirely before the origin of the search.
>
> LGTM, thanks.
>
>> If you are ok with this, should I add these two lines to all
>> *search-backward and (suitably adapted) *search-forward functions? (The
>> two lines are currently only in {re,posix}-search-backward.)
>
> It's better for all those doc strings to be consistent, yes.
Oh, dear. I made all the changes and was ready to commit them, when I
realized that those final two lines are only valid for positive COUNT.
Spelling it out for negative COUNT seems like overkill; how about this:
With COUNT positive, the match found is the COUNTth to last one (or
last, if COUNT is 1 or nil) in the buffer located entirely before
the origin of the search; correspondingly with COUNT negative.
I hope this is the last point of this issue that needs clarifying.
Steve Berman
next prev parent reply other threads:[~2016-07-12 15:14 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
2016-07-12 12:26 ` Stephen Berman
2016-07-12 13:10 ` Eli Zaretskii
2016-07-12 15:14 ` Stephen Berman [this message]
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=877fcqanxw.fsf@rub.de \
--to=stephen.berman@gmx.net \
--cc=23937@debbugs.gnu.org \
--cc=eliz@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.