Function: cider-eldoc

cider-eldoc is a byte-compiled function defined in cider-eldoc.el.

Signature

(cider-eldoc CALLBACK &rest IGNORED)

Documentation

Backend for eldoc-documentation-functions showing the arglist in the echo area.

The doc is fetched asynchronously and handed to CALLBACK, so moving the cursor never blocks on an nREPL round-trip. Returns nil (declining the slot) when CIDER can't help, so other eldoc sources still get a turn.

Source Code

;; Defined in ~/.emacs.d/elpa/cider-20260822.1520/cider-eldoc.el
(defun cider-eldoc (callback &rest _ignored)
  "Backend for `eldoc-documentation-functions' showing the arglist in the echo area.
The doc is fetched asynchronously and handed to CALLBACK, so moving the cursor
never blocks on an nREPL round-trip.  Returns nil (declining the slot) when
CIDER can't help, so other eldoc sources still get a turn."
  (when (and (cider-connected-p)
             ;; don't clobber an error message in the minibuffer
             (not (member last-command '(next-error previous-error)))
             ;; don't try to provide eldoc in EDN buffers
             (not (cider--eldoc-edn-file-p buffer-file-name)))
    (cider-eldoc-info-in-current-sexp
     (lambda (sexp-eldoc-info)
       (funcall callback (cider-eldoc--render sexp-eldoc-info))))
    ;; tell eldoc the result will arrive (possibly nil) via the callback
    t))