From: Lars Magne Ingebrigtsen <larsi@gnus.org>
Date: Mon, 4 Jul 2011 12:15:16 +0000 (+0200)
Subject: * isearch.el (isearch-search-fun-function): Clarify further the
X-Git-Tag: emacs-pretest-24.0.90~104^2~152^2~200
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f158badc8f5edcb9984acaf28a2876ea7f5f11ec;p=emacs.git

* isearch.el (isearch-search-fun-function): Clarify further the
meaning of the function returned.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 40c32784f9a..3bae3baaa71 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2011-07-04  Lars Magne Ingebrigtsen  <larsi@gnus.org>
+
+	* isearch.el (isearch-search-fun-function): Clarify further the
+	meaning of the function returned.
+
 2011-07-04  Michael Albinus  <michael.albinus@gmx.de>
 
 	* net/tramp-cmds.el (tramp-cleanup-this-connection): New command.
diff --git a/lisp/isearch.el b/lisp/isearch.el
index 58af9236d51..50e7b331c85 100644
--- a/lisp/isearch.el
+++ b/lisp/isearch.el
@@ -2227,9 +2227,12 @@ If there is no completion possible, say so and continue searching."
 
 (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.")
+This variable's value should be a function, which will be called
+with no arguments, and should return a function that takes three
+arguments: STRING, BOUND, and NOERROR.
+
+This returned function will be used by `isearch-search-string' to
+search for the first occurrence of STRING or its translation.")
 
 (defun isearch-search-fun ()
   "Return the function to use for the search.