[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/orderless 61aed3e622 11/11: Document the new rx format
From: |
ELPA Syncer |
Subject: |
[elpa] externals/orderless 61aed3e622 11/11: Document the new rx format for matching styles |
Date: |
Thu, 15 Feb 2024 15:58:55 -0500 (EST) |
branch: externals/orderless
commit 61aed3e622f90ee8ace44a84a05abc1074567b74
Author: Omar Antolín Camarena <omar.antolin@gmail.com>
Commit: Omar Antolín Camarena <omar.antolin@gmail.com>
Document the new rx format for matching styles
---
README.org | 9 ++++-----
orderless.el | 12 ++++++------
orderless.texi | 13 ++++++-------
3 files changed, 16 insertions(+), 18 deletions(-)
diff --git a/README.org b/README.org
index 80b44da335..661b2d2bd1 100644
--- a/README.org
+++ b/README.org
@@ -119,9 +119,10 @@ Protesilaos Stavrou's lovely
[[https://gitlab.com/protesilaos/modus-themes][modu
** 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 =rx= syntax.
+The predefined matching styles are:
- orderless-regexp :: the component is treated as a regexp that must
match somewhere in the candidate.
@@ -131,8 +132,6 @@ define new matching styles. The predefined ones are:
- orderless-literal :: the component is treated as a literal string
that must occur in the candidate.
- This is just =regexp-quote=.
-
- *orderless-without-literal* :: the component is a treated as a literal
string that must *not* occur in the candidate.
diff --git a/orderless.el b/orderless.el
index 15a359b75b..0ff178d290 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
diff --git a/orderless.texi b/orderless.texi
index 475dd56199..8afe2e97bc 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
- [elpa] externals/orderless updated (b24748093b -> 61aed3e622), ELPA Syncer, 2024/02/15
- [elpa] externals/orderless e49e86776b 06/11: Revert "orderless-pattern-compiler: Create fewer intermediate data structures", ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 2c952fd161 10/11: Merge pull request #161 from minad/optimize-predicate, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless ebd2b841de 04/11: orderless-pattern-compiler: Create fewer intermediate data structures, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 61aed3e622 11/11: Document the new rx format for matching styles,
ELPA Syncer <=
- [elpa] externals/orderless f6fe5e17e6 01/11: Optimize orderless-try-completion predicate calling convention, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 40f75b6bdf 08/11: orderless-literal: Use (literal string) instead of regexp-quote, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 9e515ee9a3 09/11: Drop support for Emacs 26.1 because rx does not support (literal ...), ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 674a1c75d5 07/11: Support rx sepxs as return values of matching style functions, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 55978d8578 03/11: Replace orderless--prefix+pattern by orderless--compile, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless d536e44f37 05/11: orderless-try-completion: Use or instead of if, ELPA Syncer, 2024/02/15
- [elpa] externals/orderless 3938b69914 02/11: Extract orderless--filter, ELPA Syncer, 2024/02/15