GNU bug report logs - #64367
28.2; doc string of `text-property-search-forward'

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: 28.2; doc string of `text-property-search-forward'
Date: Fri, 30 Jun 2023 15:07:02 +0000

The signature is this:

(text-property-search-forward PROPERTY
   &optional VALUE PREDICATE NOT-CURRENT)

The arguments should be described in order.

But the first line of the doc string - the most important - says this:

 Search for the next region of text where PREDICATE is true.

Not only is PREDICATE optional; it is not even the first optional arg.
The first line should describe the _default_ behavior (nil VALUE, nil
PREDICATE).  Something like this:

 Search forward for text where PROPERTY is non-nil.

Then go on to introduce, first VALUE, then PREDICATE, then NOT-CURRENT.

In GNU Emacs 28.2 (build 2, x86_64-w64-mingw32)
 of 2022-09-13
Windowing system distributor `Microsoft Corp.', version 10.0.19045
Configured using:
 `configure --with-modules --without-dbus --with-native-compilation
 --without-compress-install CFLAGS=-O2'

Previous Next

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