summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2021-01-27 03:38:49 +0100
committerEli Zaretskii <eliz@gnu.org>2021-01-27 17:18:33 +0200
commit932aba674c9a64dfd970d7c2343517c7f4c7a409 (patch)
tree4884c707009ae0765ce6d9c37a401eebf43a4f59
parent809503431d47afb9d20e8463853298a595e1fcb2 (diff)
downloademacs-932aba674c9a64dfd970d7c2343517c7f4c7a409.tar.gz
Try to improve the read-regexp doc string
* lisp/replace.el (read-regexp): Attempt to clarify the semantics (bug#46088). (cherry picked from commit eded2a7ad7d456a417354a2797c18e9a578414d7)
-rw-r--r--lisp/replace.el14
1 files changed, 8 insertions, 6 deletions
diff --git a/lisp/replace.el b/lisp/replace.el
index 0288be82d27..a7695951255 100644
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -813,12 +813,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.