diff options
author | Eli Zaretskii <eliz@gnu.org> | 2019-05-03 12:22:55 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2019-05-03 12:22:55 +0300 |
commit | d5497ec3096b3ff42fd1028b5a677cafa6386712 (patch) | |
tree | 0927d9684cd1596932500507e45e8bed611ca34d | |
parent | 8b0cb7b261b5b5443413aac65dcfc7a934838f90 (diff) | |
download | emacs-d5497ec3096b3ff42fd1028b5a677cafa6386712.tar.gz |
Improve documentation of 'isearch-regexp-function'
* lisp/isearch.el (isearch-regexp-function): Doc fix.
(Bug#35498)
-rw-r--r-- | lisp/isearch.el | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/lisp/isearch.el b/lisp/isearch.el index 6280afebdc5..bb29c2914be 100644 --- a/lisp/isearch.el +++ b/lisp/isearch.el @@ -832,12 +832,20 @@ This is like `describe-bindings', but displays only Isearch keys." 'isearch-regexp-function "25.1") (defvar isearch-regexp-function nil "Regexp-based search mode for words/symbols. -If the value is a function (e.g. `isearch-symbol-regexp'), it is -called to convert a plain search string to a regexp used by -regexp search functions. +If non-nil, a function to convert a search string to a regexp +used by regexp search functions. + +The function should accept 1 or 2 arguments: the original string +to convert, and a flag, whose non-nil value means the match +doesn't have to start or end on a word boundary. The function +should return the corresponding regexp, a string. + The symbol property `isearch-message-prefix' put on this function specifies the prefix string displayed in the search message. +Existing functions you could use as values are `word-search-regexp', +`isearch-symbol-regexp', and `char-fold-to-regexp'. + This variable is set and changed during isearch. To change the default behavior used for searches, see `search-default-mode' instead.") |