[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master a96701c 34/62: Fixed up paced-dictionary comments
From: |
Ian Dunn |
Subject: |
[elpa] master a96701c 34/62: Fixed up paced-dictionary comments |
Date: |
Sat, 9 Dec 2017 14:34:02 -0500 (EST) |
branch: master
commit a96701c503d4082c9644b8a0df773672c75b7ebf
Author: Ian Dunn <address@hidden>
Commit: Ian Dunn <address@hidden>
Fixed up paced-dictionary comments
---
paced.el | 18 +++++-------------
1 file changed, 5 insertions(+), 13 deletions(-)
diff --git a/paced.el b/paced.el
index c79fda9..a2c8783 100644
--- a/paced.el
+++ b/paced.el
@@ -39,7 +39,6 @@
;; `paced-save-named-dictionary' or `paced-save-all-dictionaries'.
;; Population commands tell a dictionary how it should refresh its usage table.
-;; The different types of populators are documented in
`paced--populator-alist'.
;; No completion frontend is provided, but a function for
;; `completion-at-point-functions' is given.
@@ -143,7 +142,9 @@ Sort hash-table USAGE-HASH by the weights (values) in the
table."
(usage-hash :initarg :usage-hash
:initform (make-hash-table :test #'equal)
:type hash-table
- :documentation "Stores the usage data for this dictionary.")
+ :documentation "Stores the usage data for this dictionary.
+
+This is a hash table, mapping a word to the times it has been used.")
(population-commands
:initarg :population-commands
:initform nil
@@ -152,16 +153,7 @@ Sort hash-table USAGE-HASH by the weights (values) in the
table."
:label "Population Commands"
:documentation "Commands to use when populating this dictionary.
-Each entry must be a list of the form (TYPE ARGS PROPS).
-
-TYPE is the type of populator; see `paced--populator-alist' for
-allowed entries here.
-
-ARGS is a list of arguments to pass to the populator, which are
-specific to the given populator.
-
-PROPS is a list of variables to let-bind when populating. Each
-entry should be of the form (VAR VALUE).")
+Each entry is a `paced-population-command'.")
(file-header-line :type string
:allocation :class
:initform ";; Paced Dictionary"
@@ -177,7 +169,7 @@ This is used with the `object-write' method.")
(const :tag "Downcase Just the First Letter"
downcase-first)
(const :tag "Upcase Just the First Letter"
upcase-first)
(const :tag "Preserve Case on Mixed-Case
Words" mixed-case))
- :label "Case Sensitive"
+ :label "Case Handling"
:documentation "A symbol indicating how case should be
handled during population.
It can be one of the following:
- [elpa] master 7c9a342 39/62: Fixed paced-global-dict-enable-alist value type, (continued)
- [elpa] master 7c9a342 39/62: Fixed paced-global-dict-enable-alist value type, Ian Dunn, 2017/12/09
- [elpa] master 8f1860a 37/62: Documentation fixes, Ian Dunn, 2017/12/09
- [elpa] master b95b016 38/62: Pushed updated info pages, Ian Dunn, 2017/12/09
- [elpa] master 964eb48 42/62: Fixed bug in completion, Ian Dunn, 2017/12/09
- [elpa] master 23c4a65 48/62: Mention common variables in population commands settings, Ian Dunn, 2017/12/09
- [elpa] master e293378 50/62: Fix completion falling back to other backend, Ian Dunn, 2017/12/09
- [elpa] master 3cd1147 45/62: Add IDs and descriptions for Contributing section, Ian Dunn, 2017/12/09
- [elpa] master 158ff71 56/62: Fixed internal links in documentation, Ian Dunn, 2017/12/09
- [elpa] master e611e61 33/62: Changed Emacs requirement to 25.1, Ian Dunn, 2017/12/09
- [elpa] master 75e9490 30/62: Account for case handling in completion, Ian Dunn, 2017/12/09
- [elpa] master a96701c 34/62: Fixed up paced-dictionary comments,
Ian Dunn <=
- [elpa] master 5f9ddc6 35/62: Mention case handling in paced-dictionary-completions, Ian Dunn, 2017/12/09
- [elpa] master 56129ca 27/62: Updated docstrings, Ian Dunn, 2017/12/09
- [elpa] master f0ac1d8 31/62: Added mixed-case case handling, Ian Dunn, 2017/12/09
- [elpa] master 5674746 49/62: Added function to check if point is in a comment, Ian Dunn, 2017/12/09
- [elpa] master 56944b8 44/62: Added documentation section for working with EDE, Ian Dunn, 2017/12/09
- [elpa] master 895f479 41/62: Pushed info pages, Ian Dunn, 2017/12/09
- [elpa] master 223809e 61/62: Fixed elpaignore file, Ian Dunn, 2017/12/09
- [elpa] master 2e306c8 40/62: Improved Introduction, Ian Dunn, 2017/12/09
- [elpa] master 139a199 53/62: Added note about dictionary properties, Ian Dunn, 2017/12/09
- [elpa] master 1234c0c 54/62: Updated info pages, Ian Dunn, 2017/12/09