emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/orderless b8e7e53a8f 152/204: Don't recommend icomplete


From: ELPA Syncer
Subject: [elpa] externals/orderless b8e7e53a8f 152/204: Don't recommend icomplete (fix #36)
Date: Tue, 11 Jan 2022 12:58:26 -0500 (EST)

branch: externals/orderless
commit b8e7e53a8f816f017b7611791e66096b16d335a8
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>

    Don't recommend icomplete (fix #36)
---
 README.org | 30 ++++++++++++------------------
 1 file changed, 12 insertions(+), 18 deletions(-)

diff --git a/README.org b/README.org
index 67d4f85837..1c55d44bdd 100644
--- a/README.org
+++ b/README.org
@@ -27,12 +27,13 @@ front-end that provides a completion UI. Any completion 
style can be
 used with the default Emacs completion UI (sometimes called minibuffer
 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). 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=.
+frameworks such as [[https://github.com/raxod502/selectrum][Selectrum]] or 
[[https://github.com/oantolin/icomplete-vertical][icomplete-vertical]]. 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). 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
@@ -45,7 +46,6 @@ If you use MELPA, the easiest way to install =orderless= is 
via
 #+begin_src emacs-lisp
   (use-package orderless
     :ensure t
-    :init (icomplete-mode) ; optional but recommended!
     :custom (completion-styles '(orderless)))
 #+end_src
 
@@ -55,15 +55,8 @@ the following configuration:
 #+begin_src emacs-lisp
 (require 'orderless)
 (setq completion-styles '(orderless))
-(icomplete-mode) ; optional but recommended!
 #+end_src
 
-(And of course, if you use another completion framework such as Ivy or
-Helm, disable it.)
-
-If you like the experience of using =orderless= with Icomplete, but wish
-the candidates displayed vertically, you can use 
[[https://github.com/oantolin/icomplete-vertical][icomplete-vertical]].
-
 Bug reports are highly welcome and appreciated!
 
 :CONTENTS:
@@ -365,13 +358,14 @@ order. In Ivy, this is done with the 
=ivy--regex-ignore-order= matcher.
 In Helm, it is the default, called "multi pattern matching".
 
 This package is significantly smaller than either of those because it
-solely defines a completion style, meant to be used with the built-in
-Icomplete completion UI, while both of those provide their own
+solely defines a completion style, meant to be used with any completion UI 
supporting completion styles while both of those provide their own
 completion UI (and many other cool features!).
 
 It is worth pointing out that Helm does provide its multi pattern
-matching as a completion style which could be used with Icomplete! (Ivy
-does not.) So, Icomplete users could, instead of using this package,
+matching as a completion style which could be used with default tab
+copletion, Icomplete, Selectrum or other UIs supporting completion
+styles! (Ivy does not provide a completion style to my knowledge.) So,
+for example, Icomplete users could, instead of using this package,
 install Helm and configure Icomplete to use it as follows:
 
 #+begin_src emacs-lisp



reply via email to

[Prev in Thread] Current Thread [Next in Thread]