aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2016-01-20 15:09:09 +0200
committerEli Zaretskii2016-01-20 15:09:09 +0200
commit65575c24aaad9bedf6b84cc062cc03fbe4dd1315 (patch)
tree8aaeefbe0a6f0a7a7e0f57bd76f2e2d4f775564e
parentc5ee6de21d4bd0562d811129e2ef7c0419a882a1 (diff)
downloademacs-65575c24aaad9bedf6b84cc062cc03fbe4dd1315.tar.gz
emacs-65575c24aaad9bedf6b84cc062cc03fbe4dd1315.zip
Fix doc string of 'isearch-search-fun-function'
* lisp/isearch.el (isearch-search-fun-function) (isearch-search-string): Doc fixes. (Bug#22411)
-rw-r--r--lisp/isearch.el13
1 files changed, 10 insertions, 3 deletions
diff --git a/lisp/isearch.el b/lisp/isearch.el
index e636ccc0d22..c36f4631549 100644
--- a/lisp/isearch.el
+++ b/lisp/isearch.el
@@ -2647,10 +2647,11 @@ the word mode."
2647 "Non-default value overrides the behavior of `isearch-search-fun-default'. 2647 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2648This variable's value should be a function, which will be called 2648This variable's value should be a function, which will be called
2649with no arguments, and should return a function that takes three 2649with no arguments, and should return a function that takes three
2650arguments: STRING, BOUND, and NOERROR. 2650arguments: STRING, BOUND, and NOERROR. See `re-search-forward'
2651for the meaning of BOUND and NOERROR arguments.
2651 2652
2652This returned function will be used by `isearch-search-string' to 2653This returned function will be used by `isearch-search-string' to
2653search for the first occurrence of STRING or its translation.") 2654search for the first occurrence of STRING.")
2654 2655
2655(defun isearch-search-fun () 2656(defun isearch-search-fun ()
2656 "Return the function to use for the search. 2657 "Return the function to use for the search.
@@ -2695,8 +2696,14 @@ Can be changed via `isearch-search-fun-function' for special needs."
2695 2696
2696(defun isearch-search-string (string bound noerror) 2697(defun isearch-search-string (string bound noerror)
2697 "Search for the first occurrence of STRING or its translation. 2698 "Search for the first occurrence of STRING or its translation.
2699STRING's characters are translated using `translation-table-for-input'
2700if that is non-nil.
2698If found, move point to the end of the occurrence, 2701If found, move point to the end of the occurrence,
2699update the match data, and return point." 2702update the match data, and return point.
2703An optional second argument bounds the search; it is a buffer position.
2704The match found must not extend after that position.
2705Optional third argument, if t, means if fail just return nil (no error).
2706 If not nil and not t, move to limit of search and return nil."
2700 (let* ((func (isearch-search-fun)) 2707 (let* ((func (isearch-search-fun))
2701 (pos1 (save-excursion (funcall func string bound noerror))) 2708 (pos1 (save-excursion (funcall func string bound noerror)))
2702 pos2) 2709 pos2)