summaryrefslogtreecommitdiff
path: root/orderless.texi
diff options
context:
space:
mode:
authorOmar Antolín Camarena <omar.antolin@gmail.com>2024-02-15 12:17:48 -0600
committerOmar Antolín Camarena <omar.antolin@gmail.com>2024-02-15 12:21:52 -0600
commit61aed3e622f90ee8ace44a84a05abc1074567b74 (patch)
treeb1666d8f0e0079c15dbb9f193a054c9525760b46 /orderless.texi
parent2c952fd161f95dd2b92aff5ffaeb50ab4e39ed10 (diff)
Document the new rx format for matching styles
Diffstat (limited to 'orderless.texi')
-rw-r--r--orderless.texi13
1 files changed, 6 insertions, 7 deletions
diff --git a/orderless.texi b/orderless.texi
index 475dd56..8afe2e9 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -56,7 +56,7 @@ Related packages
* Ivy and Helm::
* Prescient::
-* Restricting to current matches in Icicles, Ido and Ivy: Restricting to current matches in Icicles Ido and Ivy.
+* Restricting to current matches in Icicles, Ido and Ivy: Restricting to current matches in Icicles Ido and Ivy.
@end detailmenu
@end menu
@@ -151,9 +151,10 @@ Bug reports are highly welcome and appreciated!
@section Component matching styles
Each component of a pattern can match in any of several matching
-styles. A matching style is simply a function from strings to strings
-that maps a component to a regexp to match against, so it is easy to
-define new matching styles. The predefined ones are:
+styles. A matching style is simply a function from strings to regexps,
+so it is easy to define new matching styles. The regexp returned by a
+matching style can be either a string or an s-expression in @samp{rx} syntax.
+The predefined matching styles are:
@table @asis
@item orderless-regexp
@@ -166,8 +167,6 @@ If the component is not a valid regexp, it is ignored.
the component is treated as a literal string
that must occur in the candidate.
-This is just @samp{regexp-quote}.
-
@item @strong{orderless-without-literal}
the component is a treated as a literal
string that must @strong{not} occur in the candidate.
@@ -576,4 +575,4 @@ Ivy has @samp{ivy-restrict-to-matches}, bound to @samp{S-SPC}, so you can get th
effect of out of order matching without using @samp{ivy--regex-ignore-order}.
@end itemize
-@bye
+@bye \ No newline at end of file