summaryrefslogtreecommitdiff
path: root/doc/lispref/searching.texi
diff options
context:
space:
mode:
authorMattias EngdegÄrd <mattiase@acm.org>2019-12-15 22:17:11 +0100
committerMattias EngdegÄrd <mattiase@acm.org>2019-12-18 12:46:30 +0100
commitd55f2f74f53910c4416be1e023771dc3a8142727 (patch)
treedf3918f8eb0b1c77dc2f2f4d6e6d6f3415ca0a2f /doc/lispref/searching.texi
parent0a10795d0bf4fe21997f907b7d6b1fe13517912b (diff)
downloademacs-d55f2f74f53910c4416be1e023771dc3a8142727.tar.gz
More precise 'regexp-opt' documentation
* lisp/emacs-lisp/regexp-opt.el (regexp-opt): * doc/lispref/searching.texi (Regexp Functions): Be more specific about how the KEEP-ORDER argument actually works. If nil, the regexp guarantees a longest match; this is the behaviour that many callers implicitly rely on.
Diffstat (limited to 'doc/lispref/searching.texi')
-rw-r--r--doc/lispref/searching.texi10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi
index 700880c2289..c8d263d972e 100644
--- a/doc/lispref/searching.texi
+++ b/doc/lispref/searching.texi
@@ -1780,11 +1780,11 @@ if it is necessary to ensure that a postfix operator appended to
it will apply to the whole expression.
@end table
-The optional argument @var{keep-order}, if @code{nil} or omitted,
-allows the returned regexp to match the strings in any order. If
-non-@code{nil}, the match is guaranteed to be performed in the order
-given, as if the strings were made into a regexp by joining them with
-the @samp{\|} operator.
+The optional argument @var{keep-order}, if non-@code{nil}, forces the
+match to be performed in the order given, as if the strings were made
+into a regexp by joining them with the @samp{\|} operator. If nil or
+omitted, the returned regexp will always match the longest string
+possible.
Up to reordering, the resulting regexp of @code{regexp-opt} is
equivalent to but usually more efficient than that of a simplified