Function: completions--start-background-update

completions--start-background-update is a byte-compiled function defined in minibuffer.el.gz.

Signature

(completions--start-background-update &optional FORCE-EAGER-UPDATE)

Documentation

Maybe update the *Completions* buffer when the user is next idle.

Whether we update the buffer is based on completion-eager-display and completion-eager-update, and the completion table properties eager-display and eager-update.

If FORCE-EAGER-UPDATE is non-nil, we only check eager-display.

Source Code

;; Defined in /usr/src/emacs/lisp/minibuffer.el.gz
(defun completions--start-background-update (&optional force-eager-update)
  "Maybe update the *Completions* buffer when the user is next idle.

Whether we update the buffer is based on `completion-eager-display' and
`completion-eager-update', and the completion table properties
`eager-display' and `eager-update'.

If FORCE-EAGER-UPDATE is non-nil, we only check eager-display."
  (when (and force-eager-update completions--background-update-timer)
    (cancel-timer completions--background-update-timer)
    (setq completions--background-update-timer nil))
  (unless completions--background-update-timer
    (setq completions--background-update-timer
          (run-with-idle-timer
           0 nil #'completions--background-update
           force-eager-update (current-buffer)))))