summaryrefslogtreecommitdiff
path: root/lisp/progmodes/etags.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2019-10-12 21:55:59 +0300
committerEli Zaretskii <eliz@gnu.org>2019-10-12 21:55:59 +0300
commit7d3404d34d02d867c98ff5e9250f5bcf518fd427 (patch)
treebbd2bce0c17489e54bcfb41e9cafcdee070a894f /lisp/progmodes/etags.el
parent15ed1598b5e8aacea2825e6144cb3cce35101134 (diff)
downloademacs-7d3404d34d02d867c98ff5e9250f5bcf518fd427.tar.gz
; Improve a doc string in etags.el
* lisp/progmodes/etags.el (tags-complete-tags-table-file): Improve the doc string. (Bug#37538)
Diffstat (limited to 'lisp/progmodes/etags.el')
-rw-r--r--lisp/progmodes/etags.el13
1 files changed, 9 insertions, 4 deletions
diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el
index 6784894ba87..26590d8ffeb 100644
--- a/lisp/progmodes/etags.el
+++ b/lisp/progmodes/etags.el
@@ -1851,10 +1851,15 @@ For non-interactive use, superceded by `fileloop-initialize-replace'."
(defun tags-complete-tags-table-file (string predicate what)
"Complete STRING from file names in the current tags table.
-The meaning of the arguments are the same as the function form of
-COLLECTION as explained in Info node `(elisp) Programmed
-Completion', except that if WHAT does not equal t, it is treated
-as if it were nil."
+PREDICATE, if non-nil, is a function to filter possible matches:
+if it returns nil, the match is ignored. If PREDICATE is nil,
+every possible match is acceptable.
+WHAT is a flag specifying the type of completion: t means `all-completions'
+operation, any other value means `try-completions' operation.
+
+This function serves as COLLECTION argument to `completing-read',
+see the Info node `(elisp) Programmed Completion' for more detailed
+description of the arguments."
(save-excursion
;; If we need to ask for the tag table, allow that.
(let ((enable-recursive-minibuffers t))