Rename regexp-opt argument noreorder to keep-order

* doc/lispref/searching.texi (Regular Expression Functions):
* lisp/emacs-lisp/regexp-opt.el (regexp-opt):
Rename newly added `noreorder' argument to `keep-order', to avoid a
negative in the name.  Suggested by Phil Sainty (Bug#34641).
This commit is contained in:
Mattias Engdegård 2019-03-06 22:50:36 +01:00
parent 870a333281
commit 3fd2100bff
2 changed files with 5 additions and 5 deletions

View file

@ -950,7 +950,7 @@ whitespace:
@end defun
@cindex optimize regexp
@defun regexp-opt strings &optional paren noreorder
@defun regexp-opt strings &optional paren keep-order
This function returns an efficient regular expression that will match
any of the strings in the list @var{strings}. This is useful when you
need to make matching or searching as fast as possible---for example,
@ -988,7 +988,7 @@ 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{noreorder}, if @code{nil} or omitted,
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

View file

@ -84,7 +84,7 @@
;;; Code:
;;;###autoload
(defun regexp-opt (strings &optional paren noreorder)
(defun regexp-opt (strings &optional paren keep-order)
"Return a regexp to match a string in the list STRINGS.
Each string should be unique in STRINGS and should not contain
any regexps, quoted or not. Optional PAREN specifies how the
@ -114,7 +114,7 @@ nil
necessary to ensure that a postfix operator appended to it will
apply to the whole expression.
The optional argument NOREORDER, if nil or omitted, allows the
The optional argument KEEP-ORDER, if nil or omitted, allows the
returned regexp to match the strings in any order. If non-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
@ -149,7 +149,7 @@ usually more efficient than that of a simplified version:
(concat (or open "\\(?:") "a\\`\\)"))
;; If we cannot reorder, give up all attempts at
;; optimisation. There is room for improvement (Bug#34641).
((and noreorder (regexp-opt--contains-prefix sorted-strings))
((and keep-order (regexp-opt--contains-prefix sorted-strings))
(concat (or open "\\(?:")
(mapconcat #'regexp-quote strings "\\|")
"\\)"))