diff options
author | Eli Zaretskii <eliz@gnu.org> | 2016-01-20 15:09:09 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2016-01-20 15:09:09 +0200 |
commit | 65575c24aaad9bedf6b84cc062cc03fbe4dd1315 (patch) | |
tree | 8aaeefbe0a6f0a7a7e0f57bd76f2e2d4f775564e /lisp/isearch.el | |
parent | c5ee6de21d4bd0562d811129e2ef7c0419a882a1 (diff) | |
download | emacs-65575c24aaad9bedf6b84cc062cc03fbe4dd1315.tar.gz |
Fix doc string of 'isearch-search-fun-function'
* lisp/isearch.el (isearch-search-fun-function)
(isearch-search-string): Doc fixes. (Bug#22411)
Diffstat (limited to 'lisp/isearch.el')
-rw-r--r-- | lisp/isearch.el | 13 |
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." "Non-default value overrides the behavior of `isearch-search-fun-default'. 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. +arguments: STRING, BOUND, and NOERROR. See `re-search-forward' +for the meaning of BOUND and NOERROR arguments. This returned function will be used by `isearch-search-string' to -search for the first occurrence of STRING or its translation.") +search for the first occurrence of STRING.") (defun isearch-search-fun () "Return the function to use for the search. @@ -2695,8 +2696,14 @@ Can be changed via `isearch-search-fun-function' for special needs." (defun isearch-search-string (string bound noerror) "Search for the first occurrence of STRING or its translation. +STRING's characters are translated using `translation-table-for-input' +if that is non-nil. If found, move point to the end of the occurrence, -update the match data, and return point." +update the match data, and return point. +An optional second argument bounds the search; it is a buffer position. +The match found must not extend after that position. +Optional third argument, if t, means if fail just return nil (no error). + If not nil and not t, move to limit of search and return nil." (let* ((func (isearch-search-fun)) (pos1 (save-excursion (funcall func string bound noerror))) pos2) |