; 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.
This commit is contained in:
Eli Zaretskii 2022-10-15 12:52:49 +03:00
parent a06c542094
commit 1ebabaf9ff
2 changed files with 9 additions and 8 deletions

View file

@ -1384,8 +1384,8 @@ If non-nil and there's only one matching option, auto-select that.
---
*** New user option 'ecomplete-filter-regexp'.
If non-nil this user option describes what email addresses to ignore
and not add to the database.
If non-nil, this user option describes what entries not to add to the
database stored on disk.
** Dired

View file

@ -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)))