GNU bug report logs - #8101
24.0.50; `isearch-search-fun-function'

Previous Next

Full log

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Lars Magne Ingebrigtsen'" <larsi <at> gnus.org>
Cc: 8101 <at> debbugs.gnu.org
Subject: RE: 24.0.50; `isearch-search-fun-function'
Date: Sun, 3 Jul 2011 22:34:59 -0700

> > Make it clear that this var's value is a function that is 
> > called with NO ARGS and whose return value should be a
> > function of the SAME THREE ARGS as `isearch-search-string'.
> > That returned function will be used by `isearch-search-string'
> > to "search for the first occurrence of STRING or
> > its translation."
> 
> I've clarified the doc string to the best of my ability now:
> 
> (defvar isearch-search-fun-function nil
>   "Overrides the default `isearch-search-fun' behaviour.
> This variable should be a function, which will be called with no
> arguments, and should return a function that takes the same three
> arguments as `isearch-search-string' requires.")

OK, but:

1. (English) "This variable's value should be..."  It is the value, not the
variable itself.

2. (Meaning) Without the last sentence I wrote above (or something equivalent)
we don't say what the function (value of the var) _does_.  What's the point of
someone providing a function as the value if we don't say what the function is
for?

Previous Next

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