aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2022-10-15 12:52:49 +0300
committerEli Zaretskii2022-10-15 12:52:49 +0300
commit1ebabaf9ff1d7d3365d92ed2ac38c8cec9e9aa68 (patch)
tree80919f525a2780c2991a97d532b132574f78e48e
parenta06c54209499c3885c13a8d3eba7798ab3f0d688 (diff)
downloademacs-1ebabaf9ff1d7d3365d92ed2ac38c8cec9e9aa68.tar.gz
emacs-1ebabaf9ff1d7d3365d92ed2ac38c8cec9e9aa68.zip
; 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.
-rw-r--r--etc/NEWS4
-rw-r--r--lisp/ecomplete.el13
2 files changed, 9 insertions, 8 deletions
diff --git a/etc/NEWS b/etc/NEWS
index 96415870523..62004c10a6c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1384,8 +1384,8 @@ If non-nil and there's only one matching option, auto-select that.
1384 1384
1385--- 1385---
1386*** New user option 'ecomplete-filter-regexp'. 1386*** New user option 'ecomplete-filter-regexp'.
1387If non-nil this user option describes what email addresses to ignore 1387If non-nil, this user option describes what entries not to add to the
1388and not add to the database. 1388database stored on disk.
1389 1389
1390** Dired 1390** Dired
1391 1391
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 @@
70 :type '(symbol :tag "Coding system")) 70 :type '(symbol :tag "Coding system"))
71 71
72(defcustom ecomplete-sort-predicate #'ecomplete-decay 72(defcustom ecomplete-sort-predicate #'ecomplete-decay
73 "Predicate to use when sorting matched. 73 "Predicate to use when sorting matched ecomplete candidates.
74The predicate is called with two parameters that represent the 74The predicate is called with two arguments that represent the
75completion. Each parameter is a list where the first element is 75completion. Each argument is a list where the first element is
76the times the completion has been used, the second is the 76the times the completion has been used, the second is the
77timestamp of the most recent usage, and the third item is the 77timestamp of the most recent usage, and the third item is the
78string that was matched." 78string that was matched."
@@ -87,7 +87,7 @@ string that was matched."
87 :version "29.1") 87 :version "29.1")
88 88
89(defcustom ecomplete-filter-regexp nil 89(defcustom ecomplete-filter-regexp nil
90 "Regular expression of addresses to not store." 90 "Regular expression of addresses that should not be stored by ecomplete."
91 :type 'regexp 91 :type 'regexp
92 :version "29.1") 92 :version "29.1")
93 93
@@ -296,7 +296,7 @@ non-nil and there is only a single completion option available."
296 nil t))) 296 nil t)))
297 297
298(defun ecomplete-edit () 298(defun ecomplete-edit ()
299 "Prompt for an item and allow editing it." 299 "Prompt for an ecomplete item and allow editing it."
300 (interactive) 300 (interactive)
301 (let* ((type (ecomplete--prompt-type)) 301 (let* ((type (ecomplete--prompt-type))
302 (data (cdr (assq type ecomplete-database))) 302 (data (cdr (assq type ecomplete-database)))
@@ -312,7 +312,8 @@ non-nil and there is only a single completion option available."
312 (ecomplete-save))) 312 (ecomplete-save)))
313 313
314(defun ecomplete-remove () 314(defun ecomplete-remove ()
315 "Remove entries matching a regexp from the ecomplete database." 315 "Remove from the ecomplete database the entries matching a regexp.
316Prompt for the regexp to match the database entries to be removed."
316 (interactive) 317 (interactive)
317 (let* ((type (ecomplete--prompt-type)) 318 (let* ((type (ecomplete--prompt-type))
318 (data (cdr (assq type ecomplete-database))) 319 (data (cdr (assq type ecomplete-database)))