[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#64367: 28.2; doc string of `text-property-search-forward'
From: |
Eli Zaretskii |
Subject: |
bug#64367: 28.2; doc string of `text-property-search-forward' |
Date: |
Sat, 01 Jul 2023 12:32:41 +0300 |
> From: Drew Adams <drew.adams@oracle.com>
> 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.
Only preferably so. It is not always possible to do so, and thus it
is not a hard requirement.
In this case, I see no way of describing the arguments in order and
still producing a useful doc string, let alone its first line.
> 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).
Now fixed on the emacs-29 branch.
> Something like this:
>
> Search forward for text where PROPERTY is non-nil.
This loses information and is also inaccurate, so I used a different
text:
Search for next region of text where PREDICATE returns non-nil for PROPERTY.
Closing.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- bug#64367: 28.2; doc string of `text-property-search-forward',
Eli Zaretskii <=