diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2022-10-15 12:52:49 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2022-10-15 12:52:49 +0300 |
| commit | 1ebabaf9ff1d7d3365d92ed2ac38c8cec9e9aa68 (patch) | |
| tree | 80919f525a2780c2991a97d532b132574f78e48e /lisp/ecomplete.el | |
| parent | a06c54209499c3885c13a8d3eba7798ab3f0d688 (diff) | |
| download | emacs-1ebabaf9ff1d7d3365d92ed2ac38c8cec9e9aa68.tar.gz | |
; Fix documentation of ecomplete
* lisp/ecomplete.el (ecomplete-sort-predicate)
(ecomplete-filter-regexp, ecomplete-edit, ecomplete-remove): Doc
fixes.
* etc/NEWS: Fix wording of the 'ecomplete-filter-regexp' entry.
Diffstat (limited to 'lisp/ecomplete.el')
| -rw-r--r-- | lisp/ecomplete.el | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lisp/ecomplete.el b/lisp/ecomplete.el index 21f5f456ea0..54d60c84d4f 100644 --- a/lisp/ecomplete.el +++ b/lisp/ecomplete.el @@ -70,9 +70,9 @@ :type '(symbol :tag "Coding system")) (defcustom ecomplete-sort-predicate #'ecomplete-decay - "Predicate to use when sorting matched. -The predicate is called with two parameters that represent the -completion. Each parameter is a list where the first element is + "Predicate to use when sorting matched ecomplete candidates. +The predicate is called with two arguments that represent the +completion. Each argument is a list where the first element is the times the completion has been used, the second is the timestamp of the most recent usage, and the third item is the string that was matched." @@ -87,7 +87,7 @@ string that was matched." :version "29.1") (defcustom ecomplete-filter-regexp nil - "Regular expression of addresses to not store." + "Regular expression of addresses that should not be stored by ecomplete." :type 'regexp :version "29.1") @@ -296,7 +296,7 @@ non-nil and there is only a single completion option available." nil t))) (defun ecomplete-edit () - "Prompt for an item and allow editing it." + "Prompt for an ecomplete item and allow editing it." (interactive) (let* ((type (ecomplete--prompt-type)) (data (cdr (assq type ecomplete-database))) @@ -312,7 +312,8 @@ non-nil and there is only a single completion option available." (ecomplete-save))) (defun ecomplete-remove () - "Remove entries matching a regexp from the ecomplete database." + "Remove from the ecomplete database the entries matching a regexp. +Prompt for the regexp to match the database entries to be removed." (interactive) (let* ((type (ecomplete--prompt-type)) (data (cdr (assq type ecomplete-database))) |