[Emacs-diffs] /srv/bzr/emacs/trunk r104937: * isearch.el (isearch-search-fun-function): Clarify further the

[Lars Magne Ingebrigtsen]

------------------------------------------------------------
revno: 104937
committer: Lars Magne Ingebrigtsen <address@hidden>
branch nick: trunk
timestamp: Mon 2011-07-04 14:15:16 +0200
message:
  * isearch.el (isearch-search-fun-function): Clarify further the
  meaning of the function returned.
modified:
  lisp/ChangeLog
  lisp/isearch.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2011-07-04 12:12:38 +0000
+++ b/lisp/ChangeLog    2011-07-04 12:15:16 +0000
@@ -1,3 +1,8 @@
+2011-07-04  Lars Magne Ingebrigtsen  <address@hidden>
+
+       * isearch.el (isearch-search-fun-function): Clarify further the
+       meaning of the function returned.
+
 2011-07-04  Michael Albinus  <address@hidden>
 
        * net/tramp-cmds.el (tramp-cleanup-this-connection): New command.

=== modified file 'lisp/isearch.el'
--- a/lisp/isearch.el   2011-07-03 20:02:14 +0000
+++ b/lisp/isearch.el   2011-07-04 12:15:16 +0000
@@ -2227,9 +2227,12 @@
 
 (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.