summaryrefslogtreecommitdiff
path: root/lisp
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2021-01-27 03:38:49 +0100
committerLars Ingebrigtsen <larsi@gnus.org>2021-01-27 03:38:49 +0100
commiteded2a7ad7d456a417354a2797c18e9a578414d7 (patch)
treea1fe81748c1ae6e6ea2996ce25f4b5b2c6374ae9 /lisp
parentb870e584a4275be83d6878001ee613997282fd37 (diff)
downloademacs-eded2a7ad7d456a417354a2797c18e9a578414d7.tar.gz
emacs-eded2a7ad7d456a417354a2797c18e9a578414d7.tar.bz2
emacs-eded2a7ad7d456a417354a2797c18e9a578414d7.zip
Try to improve the read-regexp doc string
* lisp/replace.el (read-regexp): Attempt to clarify the semantics (bug#46088).
Diffstat (limited to 'lisp')
-rw-r--r--lisp/replace.el14
1 files changed, 8 insertions, 6 deletions
diff --git a/lisp/replace.el b/lisp/replace.el
index db5b340631a..cf1dcb4992f 100644
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -835,12 +835,14 @@ If DEFAULTS is a list of strings, the first element is the
default return value, but all the elements are accessible
using the history command \\<minibuffer-local-map>\\[next-history-element].
-If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
-is non-nil, we use that in place of DEFAULTS in the following:
- If DEFAULTS is the symbol `regexp-history-last', we use the first
- element of HISTORY (if specified) or `regexp-history'.
- If DEFAULTS is a function, we call it with no arguments and use
- what it returns, which should be either nil, a string, or a list of strings.
+DEFAULTS can be a symbol. If DEFAULTS is the symbol
+`regexp-history-last', we use the first element of HISTORY (if
+specified) or `regexp-history'. If DEFAULTS is a symbol with a
+function definition, we call it with no arguments and use what it
+returns, which should be either nil, a string, or a list of
+strings. Other symbol values for DEFAULTS are ignored. If
+`read-regexp-defaults-function' is non-nil, its value is used
+instead of DEFAULTS in the two cases described in this paragraph.
We append the standard values from `read-regexp-suggestions' to DEFAULTS
before using it.