Clarify the type of value that 'ignore-completion-table' returns

* lisp/vc/vc.el: Clarify the type of value that
'ignore-completion-table' returns
(https://lists.gnu.org/archive/html/emacs-devel/2025-12/msg00895.html).
This commit is contained in:
Dmitry Gutov 2025-12-31 05:07:16 +02:00
parent ee918cafda
commit 4473b11797

View file

@ -630,11 +630,14 @@
;;
;; - ignore-completion-table (directory)
;;
;; Return the completion table for files ignored by the current
;; Return the list of patterns for files ignored by the current
;; version control system, e.g., the entries in `.gitignore' and
;; `.bzrignore'. The default behavior is to read the contents of
;; the file returned by the `find-ignore-file' function.
;;
;; NOTE: The return value should be a list of strings, not a general
;; completion table value, despite what the name implies.
;;
;; - find-ignore-file (file)
;;
;; Return the ignore file that controls FILE, e.g. `.gitignore' or