summaryrefslogtreecommitdiff
path: root/orderless.el
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.el
parent2c952fd161f95dd2b92aff5ffaeb50ab4e39ed10 (diff)
Document the new rx format for matching styles
Diffstat (limited to 'orderless.el')
-rw-r--r--orderless.el12
1 files changed, 6 insertions, 6 deletions
diff --git a/orderless.el b/orderless.el
index 15a359b..0ff178d 100644
--- a/orderless.el
+++ b/orderless.el
@@ -114,12 +114,12 @@ or a function of a single string argument."
"List of component matching styles.
If this variable is nil, regexp matching is assumed.
-A matching style is simply a function from strings to strings
-that takes a component to a regexp to match against. If the
-resulting regexp has no capturing groups, the entire match is
-highlighted, otherwise just the captured groups are. Several are
-provided with this package: try customizing this variable to see
-a list of them."
+A matching style is simply a function from strings to regexps.
+The returned regexps can be either strings or s-expressions in
+`rx' syntax. If the resulting regexp has no capturing groups,
+the entire match is highlighted, otherwise just the captured
+groups are. Several are provided with this package: try
+customizing this variable to see a list of them."
:type 'hook
:options (list #'orderless-regexp
#'orderless-literal