* isearch.el (isearch-search-fun-function): Clarify the doc string
authorLars Magne Ingebrigtsen <larsi@gnus.org>
Sun, 3 Jul 2011 20:02:14 +0000 (22:02 +0200)
committerLars Magne Ingebrigtsen <larsi@gnus.org>
Sun, 3 Jul 2011 20:02:14 +0000 (22:02 +0200)
(bug#8101).

lisp/ChangeLog
lisp/isearch.el

index 6949d77..7ce4753 100644 (file)
@@ -1,3 +1,8 @@
+2011-07-03  Lars Magne Ingebrigtsen  <larsi@gnus.org>
+
+       * isearch.el (isearch-search-fun-function): Clarify the doc string
+       (bug#8101).
+
 2011-07-03  Richard Kim <emacs18@gmail.com> (tiny change)
 
        * textmodes/texnfo-upd.el (texinfo-insert-menu): Don't insert
index 7f018ab..58af923 100644 (file)
@@ -2226,10 +2226,10 @@ If there is no completion possible, say so and continue searching."
 ;; Searching
 
 (defvar isearch-search-fun-function nil
-  "Override `isearch-search-fun'.
-This function should return the search function for Isearch to use.
-It will call this function with three arguments
-as if it were `search-forward'.")
+  "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.")
 
 (defun isearch-search-fun ()
   "Return the function to use for the search.