branch: externals/orderless
commit cce7072dc3018ec7909fee470ccb5a9fc43d157a
Author: Omar Antolín <[email protected]>
Commit: Omar Antolín <[email protected]>
Mention completion-category-defaults in the documentation
---
README.org | 5 ++++-
orderless.texi | 8 ++++++--
2 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index 1d45a73012..67d4f85837 100644
--- a/README.org
+++ b/README.org
@@ -29,7 +29,10 @@ tab completion), with the built-in Icomplete package (which
is similar
to the more well-known Ido Mode), or with some third party completion
frameworks such as [[https://github.com/raxod502/selectrum][Selectrum]]. To
use a completion style in this
fashion simply add it as an entry in the variables =completion-styles=
-and =completion-category-overrides= (see their documentation).
+and =completion-category-overrides= (see their documentation). You may
+also want to modify the =completion-category-defaults= variable, which
+serves as a default value for =completion-category-overrides=: if you
+want to use =orderless= exclusively, set both variables to =nil=.
With a bit of effort, it might still be possible to use =orderless= with
other completion UIs, even if those UIs don't support the standard
diff --git a/orderless.texi b/orderless.texi
index c3dac6d0c7..d33f14ffd8 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -77,7 +77,10 @@ tab completion), with the built-in Icomplete package (which
is similar
to the more well-known Ido Mode), or with some third party completion
frameworks such as @uref{https://github.com/raxod502/selectrum, Selectrum}. To
use a completion style in this
fashion simply add it as an entry in the variables @samp{completion-styles}
-and @samp{completion-category-overrides} (see their documentation).
+and @samp{completion-category-overrides} (see their documentation). You may
+also want to modify the @samp{completion-category-defaults} variable, which
+serves as a default value for @samp{completion-category-overrides}: if you
+want to use @samp{orderless} exclusively, set both variables to @samp{nil}.
With a bit of effort, it might still be possible to use @samp{orderless} with
other completion UIs, even if those UIs don't support the standard
@@ -368,7 +371,8 @@ To use @samp{orderless} from Ivy add this to your Ivy
configuration:
@section Selectrum
Recent versions of Selectrum default to using whatever completion
-styles you have configured. You can use @samp{orderless} that way, or you can
use this configuration:
+styles you have configured. You can use @samp{orderless} that way, or you can
+use this configuration:
@lisp
(setq selectrum-refine-candidates-function #'orderless-filter)
