GNU bug report logs - #71879
30.0.60; Docstring error in NOERROR argument part of re-search-forward

Previous Next

Package: emacs;

Reported by: Gerard Vermeulen <gerard.vermeulen <at> posteo.net>

Date: Mon, 1 Jul 2024 16:14:01 UTC

Severity: normal

Found in version 30.0.60

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#71879: closed (30.0.60; Docstring error in NOERROR argument
 part of re-search-forward)
Date: Sat, 13 Jul 2024 10:24:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Sat, 13 Jul 2024 13:23:12 +0300
with message-id <86sewdk2un.fsf <at> gnu.org>
and subject line Re: bug#71879: 30.0.60; Docstring error in NOERROR argument part of re-search-forward
has caused the debbugs.gnu.org bug report #71879,
regarding 30.0.60; Docstring error in NOERROR argument part of re-search-forward
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
71879: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=71879
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Gerard Vermeulen <gerard.vermeulen <at> posteo.net>
To: Bug gnu emacs <bug-gnu-emacs <at> gnu.org>
Subject: 30.0.60; Docstring error in NOERROR argument part of re-search-forward
Date: Mon, 01 Jul 2024 16:13:38 +0000
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).

See for instance: (info "(Eintr) the-the")

By the way: using the-the finds a duplication "is is" in the NEWS file 
but I
am unsure whether this merits a bug report.

Regards -- Gerard






[Message part 3 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org>
To: Gerard Vermeulen <gerard.vermeulen <at> posteo.net>
Cc: 71879-done <at> debbugs.gnu.org
Subject: Re: bug#71879: 30.0.60; Docstring error in NOERROR argument part of
 re-search-forward
Date: Sat, 13 Jul 2024 13:23:12 +0300
> Date: Mon, 01 Jul 2024 17:48:18 +0000
> From: Gerard Vermeulen <gerard.vermeulen <at> posteo.net>
> Cc: 71879 <at> debbugs.gnu.org
> 
> On 01.07.2024 19:30, Eli Zaretskii wrote:
> > 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.

I've modified the doc string a bit to make this intent more clear, and
I'm therefore closing the bug.


This bug report was last modified 1 year and 3 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.