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

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

[elpa] externals/orderless 0f674253a8 199/204: Reword sentence for clari


From: ELPA Syncer
Subject: [elpa] externals/orderless 0f674253a8 199/204: Reword sentence for clarity
Date: Tue, 11 Jan 2022 12:58:31 -0500 (EST)

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

    Reword sentence for clarity
---
 README.org     |  4 ++--
 orderless.texi | 30 +++++++++++++++++++++---------
 2 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/README.org b/README.org
index e3a05f35e1..25794864b6 100644
--- a/README.org
+++ b/README.org
@@ -39,8 +39,8 @@ used when Emacs commands prompt the user in the minibuffer 
for some
 input, but there is also completion at point in normal buffers,
 typically used for identifiers in programming languages. Completion
 styles can also be used for that purpose by completion at point UIs
-such as [[https://github.com/minad/corfu][Corfu]], the function 
=consult-completion-in-region= from 
[[https://github.com/minad/consult][Consult]]
-or [[https://company-mode.github.io/][Company]].
+such as [[https://github.com/minad/corfu][Corfu]], 
[[https://company-mode.github.io/][Company]] or the function 
=consult-completion-in-region=
+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
diff --git a/orderless.texi b/orderless.texi
index 3b84d37e53..e752f06e5f 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -75,14 +75,24 @@ A completion style is a back-end for completion and is used 
from a
 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 @uref{https://github.com/minad/vertico, Vertico}, 
@uref{https://github.com/raxod502/selectrum, Selectrum} (in its default 
configuration),
-or @uref{https://github.com/oantolin/icomplete-vertical, icomplete-vertical} 
(note there is also a @emph{built-in} package named
-icomplete-vertical in the unreleased version 28 of Emacs, which will
-eventually make the third party icomplete-vertical obsolete
----orderless works equally well with both icomplete-vertical
-packages). To use a completion style with any of these completion UIs
-simply add it as an entry in the variables @samp{completion-styles} and
+to the more well-known Ido Mode), or with some third party minibuffer
+completion frameworks such as @uref{https://github.com/minad/vertico, 
Vertico}, @uref{https://github.com/raxod502/selectrum, Selectrum} (in its 
default
+configuration), or @uref{https://github.com/oantolin/icomplete-vertical, 
icomplete-vertical} (note there is also a @emph{built-in}
+package named icomplete-vertical in the unreleased version 28 of
+Emacs, which will eventually make the third party icomplete-vertical
+obsolete ---orderless works equally well with both icomplete-vertical
+packages).
+
+All the completion UIs just mentioned are for minibuffer completion,
+used when Emacs commands prompt the user in the minibuffer for some
+input, but there is also completion at point in normal buffers,
+typically used for identifiers in programming languages. Completion
+styles can also be used for that purpose by completion at point UIs
+such as @uref{https://github.com/minad/corfu, Corfu}, 
@uref{https://company-mode.github.io/, Company} or the function 
@samp{consult-completion-in-region}
+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
@@ -91,7 +101,9 @@ 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
 Emacs completion styles. Currently there is support for 
@uref{https://github.com/abo-abo/swiper, Ivy} (see
-below).
+below). Also, while Company does support completion styles directly,
+pressing @samp{SPC} takes you out of completion, so comfortably using
+@samp{orderless} with it takes a bit of configuration (see below).
 
 If you use MELPA, the easiest way to install @samp{orderless} is via
 @samp{package-install}. If you use both MELPA and @samp{use-package}, you can 
use:



reply via email to

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