GNU bug report logs -
#35498
26.2; doc string of `isearch-regexp-function'
Previous Next
Reported by: Drew Adams <drew.adams <at> oracle.com>
Date: Tue, 30 Apr 2019 01:50:02 UTC
Severity: minor
Found in version 26.2
Done: Eli Zaretskii <eliz <at> gnu.org>
Bug is archived. No further changes may be made.
Full log
Message #13 received at 35498-done <at> debbugs.gnu.org (full text, mbox):
> > The doc string should describe the possible values and their
> > meanings/behaviors. Currently it describes only a function as value.
>
> I added the existing functions that could be used as values. Their
> descriptions are available by using the hyperlink, so no need to
> duplicate that here. The list is, of course, not exhaustive, as Lisp
> programs could define their own functions.
It should instead, or in addition, specify what args it
must accept and what kind of value it must return.
Examples are only nice-to-have, not a replacement for a
description/spec.
> > Searching isearch.el it seems that this variable can be any of the
> > values possible for `search-default-mode'. Please describe each of the
> > values for `isearch-regexp-function'.
>
> See above: not needed.
The doc string should say that the value can be t, nil,
or a function. It should say what the behavior is for
each. Or, as I suggested, it can just say that the
value can be anything acceptable for `search-default-mode'.
> > Even when the value is a function the description could be better,
> > saying that it must accept a string as its first arg and must return a
> > string. That can be surmised from saying that it converts a plain
> > search string to a regexp [search string], but it could be clearer.
>
> Added.
OK, good. That cancels what I said first, above. I
thought you were saying that it is sufficient to just
give a list of existing such function values.
This bug report was last modified 6 years and 77 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.