branch: externals/pabbrev
commit b1ba1dae894bf6736966400d91342f359ab48907
Author: Arthur Miller <arthur.mil...@live.com>
Commit: Arthur Miller <arthur.mil...@live.com>
Use description from the docs in readme.
---
README.org | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index c356e05611..86b89add32 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,4 @@
-#+title: pabbrev - Predictive Abbreviation Expansions for Emacs
+#+title: Pabbrev - Predictive Abbreviation Expansions for Emacs
#+author: Phillip Lord
#+language: en
#+export_file_name: pabbrev.texi
@@ -12,21 +12,24 @@
Pabbrev provides predictive abbreviation expansion with no configuration needed
and works with any mode.
-Pabbrev is a small package, which analyzes buffer text in the buffer and
-collects usage statistics to rank most used words highest. Pabbrev is
-un-intrusive and out of the way. It does not provide any user interface on its
-own other than TAB-based insertion on demand. Pabbrev can be used with Emacs
-completion facilities and packages such as Companry or Corfu, for the user
-interaction and user interface.
+Pabbrev is another abbreviation expansion mode somewhat like
+dabbrev-expand, in that it looks through the current buffer for
+symbols that can complete the current symbol. Unlike dabbrev-expand,
+it does this by discovering the words during the Emacs idle time, and
+places the results into data structures which enable very rapid
+extraction of expansions. The upshot of this is that it can offer
+suggestions as you type, without causing an unacceptable slow down.
-For more details see pabbrev.el
+Pabbrev is a small package, un-intrusive and out of the way. Pabbrev
+can be used with Emacs completion facilities and packages such as Company
+or Corfu, for the user interaction and user interface.
* Features
- Timer-based auto-suggestions (does not block main user-interface)
- In-buffer color-coded display of best candidate
-- Suggestions by usage frequency or shortest-prefix
-- The current candidate is inserted with =TAB=
+- Suggestions ranked by usage frequency or shortest-prefix
+- The best suggestion is inserted with TAB, on demand
- List of all available suggestions
* Installation and Configuration
