From: Gerard Vermeulen <gerard.vermeulen@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 71879@debbugs.gnu.org
Subject: bug#71879: 30.0.60; Docstring error in NOERROR argument part of re-search-forward
Date: Mon, 01 Jul 2024 17:48:18 +0000 [thread overview]
Message-ID: <77229ea00f071fa9fb077ab6e6737368@posteo.net> (raw)
In-Reply-To: <86plrxdnq3.fsf@gnu.org>
On 01.07.2024 19:30, Eli Zaretskii wrote:
>> Date: Mon, 01 Jul 2024 16:13:38 +0000
>> From: Gerard Vermeulen <gerard.vermeulen@posteo.net>
>>
>> Hello,
>>
>> The last "if" clause in the NOERROR part of the re-search-forward
>> docstring
>> is wrong.
>>
>> It reads "if it is neither nil nor t, move to the limit of search and
>> return nil."
>>
>> but if NOERROR equals neither nil nor t re-search-forward returns
>> the start position of the match (when found) or nil (when no match
>> found).
>
> The full text of that part is as follows:
>
> The optional third argument NOERROR indicates how errors are handled
> when the search fails. If it is nil or omitted, emit an error; if
> it is t, simply return nil and do nothing; if it is neither nil nor
> t, move to the limit of search and return nil.
>
> Note the first sentence of the paragraph: this entire paragraph
> describes how NOERROR affects the case when the search _fails_. Thus,
> the situation where the search succeeds is not relevant to the above
> part of the doc string.
>
> So I think this text is accurate and correct.
>
Yes, I agree that the paragraph can be read like this.
next prev parent reply other threads:[~2024-07-01 17:48 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-01 16:13 bug#71879: 30.0.60; Docstring error in NOERROR argument part of re-search-forward Gerard Vermeulen
2024-07-01 17:30 ` Eli Zaretskii
2024-07-01 17:48 ` Gerard Vermeulen [this message]
2024-07-13 10:23 ` Eli Zaretskii
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=77229ea00f071fa9fb077ab6e6737368@posteo.net \
--to=gerard.vermeulen@posteo.net \
--cc=71879@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 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).