diff options
| author | Daniel Mendler <mail@daniel-mendler.de> | 2024-04-01 11:58:30 +0200 |
|---|---|---|
| committer | Daniel Mendler <mail@daniel-mendler.de> | 2024-04-01 11:59:16 +0200 |
| commit | ac4aeb66f331f4c4a430d5556071e33177304c37 (patch) | |
| tree | dbc1b2a3da0cb59a2e3e26eb7de879bee0d02c16 | |
| parent | 3847f311077efa17951a786d2759f2639c5f43c8 (diff) | |
README: Clarification about completion-category-* variables (Fix #117)
| -rw-r--r-- | README.org | 11 | ||||
| -rw-r--r-- | orderless.texi | 11 |
2 files changed, 14 insertions, 8 deletions
@@ -41,10 +41,13 @@ from [[https://github.com/minad/consult][Consult]]. To use a completion style with any of the above mentioned completion UIs simply add it as an entry in the variables =completion-styles= 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=. +=completion-category-overrides= and =completion-category-defaults= (see +their documentation). + +The =completion-category-defaults= variable serves as a default value +for =completion-category-overrides=. If you want to use =orderless= +exclusively, set both variables to =nil=, but be aware that +=completion-category-defaults= is modified by packages at load time. 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 c62037d..74fc048 100644 --- a/orderless.texi +++ b/orderless.texi @@ -91,10 +91,13 @@ from @uref{https://github.com/minad/consult, Consult}. To use a completion style with any of the above mentioned completion UIs simply add it as an entry in the variables @samp{completion-styles} 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}. +@samp{completion-category-overrides} and @samp{completion-category-defaults} (see +their documentation). + +The @samp{completion-category-defaults} variable serves as a default value +for @samp{completion-category-overrides}. If you want to use @samp{orderless} +exclusively, set both variables to @samp{nil}, but be aware that +@samp{completion-category-defaults} is modified by packages at load time. 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 |
