branch: externals/orderless
commit a609004d5fc3d2755545069187b6362e7a92d017
Author: Omar Antolín <[email protected]>
Commit: Omar Antolín <[email protected]>
Document that orderless-regexp matches invalid regexps literally
---
README.org | 8 ++++++--
orderless.texi | 8 +++++++-
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index 50a1ba54cb..ef881b1022 100644
--- a/README.org
+++ b/README.org
@@ -100,8 +100,12 @@ define new matching styles. The predefined ones are:
- orderless-regexp :: the component is treated as a regexp that must
match somewhere in the candidate.
- This is simply the identity function!
-
+ If the component is not a valid regexp, it matches literally.
+ (Having the component be invalid is actually pretty common while you
+ are typing, so be prepared for the results to be a little funny
+ before you close a bracket or parentheses, etc.)
+
+
- orderless-literal :: the component is treated as a literal string
that must occur in the candidate.
diff --git a/orderless.texi b/orderless.texi
index 4591e5023d..ce882c330a 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -131,8 +131,14 @@ define new matching styles. The predefined ones are:
the component is treated as a regexp that must
match somewhere in the candidate.
-This is simply the identity function!
+If the component is not a valid regexp, it matches literally.
+(Having the component be invalid is actually pretty common while you
+are typing, so be prepared for the results to be a little funny
+before you close a bracket or parentheses, etc.)
+@end table
+
+@table @asis
@item orderless-literal
the component is treated as a literal string
that must occur in the candidate.
