[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/vertico f47b8bb: Update readme
From: |
ELPA Syncer |
Subject: |
[elpa] externals/vertico f47b8bb: Update readme |
Date: |
Sat, 29 May 2021 09:57:25 -0400 (EDT) |
branch: externals/vertico
commit f47b8bbb34307e0aef896dcffd39fe9cb3572796
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Update readme
---
README.org | 37 +++++++++++++++++++++++--------------
vertico.el | 7 +++----
2 files changed, 26 insertions(+), 18 deletions(-)
diff --git a/README.org b/README.org
index f0b7a52..c1e6f59 100644
--- a/README.org
+++ b/README.org
@@ -11,11 +11,13 @@
* Introduction
Vertico provides a minimalistic vertical completion UI, which is based on the
-default completion system. By reusing the default system, Vertico achieves full
-compatibility with built-in Emacs commands and completion tables. Vertico is
-pretty bare-bone and comes with only a minimal set of commands. The code base
is
-small (~500 lines of code without whitespace and comments). Additional
-enhancements can be installed separately via complementary packages.
+default completion system. By reusing the built-in facilities system, Vertico
+achieves full compatibility with built-in Emacs commands and completion tables.
+Vertico only provides the completion UI and comes with only a minimal set of
+commands. The code base is small and maintainable (~500 lines of code without
+whitespace and comments).
+
+Additional enhancements can be installed separately via complementary packages.
* Features
@@ -160,13 +162,15 @@ the same spirit as Vertico.
* Alternatives
There are many alternative completion UIs, each UI with its own advantages and
-disadvantages. The [[https://github.com/raxod502/selectrum][Selectrum readme]]
gives an extensive comparison of many
-available completion systems from the perspective of Selectrum.
+disadvantages.
-Vertico aims to be fully compliant with all Emacs commands and achieves that
-with a minimal code base, relying purely on ~completing-read~ while avoiding to
+Vertico aims to be 100% compliant with all Emacs commands and achieves that
with
+a minimal code base, relying purely on ~completing-read~ while avoiding to
invent its own APIs. Inventing a custom API as Helm or Ivy is explicitly
avoided
-in order to increase flexibility and package reuse.
+in order to increase flexibility and package reuse. Due to its small code base
+and reuse of the Emacs built-in facilities, bugs are less likely to occur in
+comparison to completion UIs or full completion systems, which reimplement a
lot
+of functionality.
Since Vertico only provides the UI, you may want to combine it with some of the
complementary packages, to give a full-featured completion experience similar
to
@@ -175,16 +179,21 @@ to their liking - completion plays an integral part in
how the users interacts
with Emacs. There are at least two other interactive completion UIs, which
follow a similar philosophy:
-- [[https://github.com/raxod502/selectrum][Selectrum]]: If you are looking for
a less minimalistic and more full-featured
- (but also more complex) package, you may be interested in Selectrum, which
has
- a similar UI as Vertico. Additionally Selectrum supports Avy-style quick
keys,
- a horizontal display and a configurable buffer display.
+- [[https://github.com/raxod502/selectrum][Selectrum]]: If you are looking for
a less minimalistic
+ (but more complex) package, you may be interested in Selectrum, which has a
+ similar UI as Vertico. Additionally Selectrum supports Avy-style quick keys,
a
+ horizontal display and a configurable buffer display. On the other hand,
+ Selectrum is not not yet fully compatible with every Emacs completion command
+ ([[https://github.com/raxod502/selectrum/issues/481][Issue #481]]).
- [[https://github.com/oantolin/icomplete-vertical][Icomplete-vertical]]: This
package enhances the Emacs builtin Icomplete with a
vertical display. In contrast to Vertico, the candidates are rotated such
that
the current candidate always appears at the top. From my perspective,
candidate rotation feels a bit less intuitive than the UI of Vertico or
Selectrum. Note that Emacs 28 offers a built-in ~icomplete-vertical-mode~.
+See also the [[https://github.com/raxod502/selectrum][Selectrum readme]],
which gives an extensive comparison of many
+available completion systems from the perspective of Selectrum.
+
* Problematic completion commands
Vertico works well and is robust in most scenarios. However a few completion
diff --git a/vertico.el b/vertico.el
index 668827a..d5d7516 100644
--- a/vertico.el
+++ b/vertico.el
@@ -27,10 +27,9 @@
;;; Commentary:
;; Vertico provides a minimalistic vertical completion UI, which is
-;; based on the default completion system. By reusing the default
-;; system, Vertico achieves full compatibility with built-in Emacs
-;; commands and completion tables. Vertico is pretty bare-bone and
-;; comes with only a minimal set of commands.
+;; based on the default completion system. By reusing the built-in
+;; facilities, Vertico achieves full compatibility with built-in Emacs
+;; commands and completion tables.
;;; Code:
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/vertico f47b8bb: Update readme,
ELPA Syncer <=