Function: bind-key--get-binding-description

bind-key--get-binding-description is a byte-compiled function defined in bind-key.el.gz.

Signature

(bind-key--get-binding-description ELEM)

Aliases

get-binding-description (obsolete since 30.1)

Source Code

;; Defined in /usr/src/emacs/lisp/bind-key.el.gz
(defun bind-key--get-binding-description (elem)
  (let (doc)
    (cond
     ((symbolp elem)
      (cond
       ((and bind-key-describe-special-forms (keymapp elem)
             ;; FIXME: Is this really ever better than the symbol-name?
             ;; FIXME: `variable-documentation' describe what's in
             ;; elem's `symbol-value', whereas `elem' here stands for
             ;; its `symbol-function'.
             (stringp (setq doc (get elem 'variable-documentation))))
        doc)
       (t elem)))
     ((and bind-key-describe-special-forms (functionp elem)
           (stringp (setq doc (documentation elem))))
      doc) ;;FIXME: Keep only the first line?
     ;; FIXME: Use `help-fns-function-name'?
     ((consp elem)
      (if (symbolp (car elem))
          (format "#<%s>" (car elem))
        elem))
     (t
      (format "#<%s>" (type-of elem))))))