summaryrefslogtreecommitdiff
path: root/orderless.texi
diff options
context:
space:
mode:
authorOmar Antolín <omar.antolin@gmail.com>2021-01-21 13:25:34 -0600
committerOmar Antolín <omar.antolin@gmail.com>2021-01-21 13:25:34 -0600
commitcce7072dc3018ec7909fee470ccb5a9fc43d157a (patch)
tree11cc3109a4b13905894a25322fc63b28ae054a89 /orderless.texi
parent8e28b74aab66e9ae47a92098215a73f47c17595f (diff)
Mention completion-category-defaults in the documentation
Diffstat (limited to 'orderless.texi')
-rw-r--r--orderless.texi8
1 files changed, 6 insertions, 2 deletions
diff --git a/orderless.texi b/orderless.texi
index c3dac6d..d33f14f 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)