Function: transient-get-summary

transient-get-summary is a byte-compiled function defined in transient.el.

Signature

(transient-get-summary OBJ)

Documentation

Return brief summary about the menu element at point.

If OBJ's summary slot is a string, use that. If it is a function, call that with OBJ as the only argument and use the returned string. If summary is or returns something other than a string or nil, show no summary. If summary is or returns nil, use the first line of the documentation string, if any.

If RETURN is non-nil, return the summary instead of showing it. This is used when a tooltip is needed.

Implementations

((obj transient-object)) in `transient.el'.

Undocumented

Source Code

;; Defined in ~/.emacs.d/elpa/transient-20260414.1009/transient.el
(cl-defgeneric transient-get-summary (obj)
  "Return brief summary about the menu element at point.

If OBJ's `summary' slot is a string, use that.  If it is a function,
call that with OBJ as the only argument and use the returned string.
If `summary' is or returns something other than a string or nil,
show no summary.  If `summary' is or returns nil, use the first line
of the documentation string, if any.

If RETURN is non-nil, return the summary instead of showing it.
This is used when a tooltip is needed.")