[Top][All Lists]

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

[elpa] master 2e306c8 40/62: Improved Introduction

From: Ian Dunn
Subject: [elpa] master 2e306c8 40/62: Improved Introduction
Date: Sat, 9 Dec 2017 14:34:03 -0500 (EST)

branch: master
commit 2e306c8e3554230ebc177cc7f70601083b9fd43c
Author: Ian Dunn <address@hidden>
Commit: Ian Dunn <address@hidden>

    Improved Introduction
    * paced.org (Introduction): Consolidated section.
     (Selecting Dictionaries): Explicitly mention completion.
    * paced.el (paced-global-dict-enable-alist): Explicitly state its purpose.
 paced.el  |  2 +-
 paced.org | 29 ++++++++++++-----------------
 2 files changed, 13 insertions(+), 18 deletions(-)

diff --git a/paced.el b/paced.el
index 7a65a64..128a04a 100644
--- a/paced.el
+++ b/paced.el
@@ -288,7 +288,7 @@ customization interface."
   (oref obj object-name))
 (defcustom paced-global-dict-enable-alist nil
-  "Global enable list.
+  "List that determines which dictionaries should be active.
 Each entry has the form (CONDITION . DICT-KEY), where CONDITION
 is one of the following forms:
diff --git a/paced.org b/paced.org
index 48daaf6..78bef8b 100644
--- a/paced.org
+++ b/paced.org
@@ -35,24 +35,19 @@ along with this program.  If not, see 
 :DESCRIPTION: Brief Introduction to paced
 Paced (Predictive Abbreviation Completion and Expansion using Dictionaries)
-provides a completion backend based on what a user has already written.
+scans a group of files (determined by "population commands") to construct a
+usage table (dictionary).  Words (or symbols) are sorted by their usage, and 
+be later presented to the user for completion.  A dictionary can then be saved
+to a file, to be loaded later.
-Paced scans one or more files or buffers and constructs a table of words,
-weighted by how often they're used.
+Population commands determine how a dictionary should be filled with words or
+symbols.  A dictionary may have multiple population commands, and population 
+be performed asynchronously.  Once population is finished, the contents are
+sorted, with more commonly used words at the front.  Dictionaries may be edited
+through EIEIO's customize-object interface.
-Once it's constructed this table, it can present them to the user for
-completion, sorted by their weights.
-Creating a new dictionary is easy; just use ~paced-create-new-dictionary~ to
-create a new dictionary, then set the population commands and sort method.
-Dictionaries are persistent; they're saved with ~paced-save-named-dictionary~ 
-Population commands tell a dictionary how it should refresh its usage table.
-No completion frontend is provided, but a function for
-~completion-at-point-functions~ is given.
+Completion is done through ~completion-at-point~.  The dictionary to use for
+completion can be customized.
 ** Similar Packages
@@ -163,7 +158,7 @@ documented in the edit buffer.
 Paced provides a mechanism called the "enable list", that allows a user to
-enable certain dictionaries given certain conditions.
+enable certain dictionaries for completion given certain conditions.
 There are two enable lists: a global and local one.  They both work the same,
 with the local one taking precedence.  Each entry in the list has a condition

reply via email to

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