bug#35498: 26.2; doc string of `isearch-regexp-function'

[Eli Zaretskii]

> Date: Fri, 3 May 2019 07:47:57 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 35498-done@debbugs.gnu.org
> 
> > > 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.

Did you look at the changes I installed?  Because I actually did that.

> > > 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.

Did you see the changes I install?

> > > 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.

So why did you send them anyway?