Function: transient-format-description

transient-format-description is a byte-compiled function defined in transient.el.

Signature

(transient-format-description OBJ)

Documentation

Format OBJ's description for display and return the result.

Implementations

(transient-format-description (OBJ magit--git-submodule-suffix)) in `magit-submodule.el'.

Undocumented

(transient-format-description (OBJ magit--git-variable)) in `magit-transient.el'.

Undocumented

(transient-format-description (OBJ transient-cons-option)) in `transient.el'.

Undocumented

(transient-format-description (OBJ transient-lisp-variable)) in `transient.el'.

Undocumented

:around (transient-format-description (OBJ transient-suffix)) in `transient.el'.

Format the description by calling the next method. If the result is nil, then use "(BUG: no description)" as the description. If the OBJ's `key' is currently unreachable, then apply the face `transient-unreachable' to the complete string.

(transient-format-description (OBJ transient-group)) in `transient.el'.

Format the description by calling the next method. If the result doesn't use the `face' property at all, then apply the face `transient-heading' to the complete string.

(transient-format-description (OBJ transient-value-preset)) in `transient.el'.

Undocumented

(transient-format-description (OBJ transient-suffix)) in `transient.el'.

The `description' slot may be a function, in which case that is called inside the correct buffer (see `transient--insert-group') and its value is returned to the caller.

Source Code

;; Defined in ~/.emacs.d/elpa/transient-20260414.1009/transient.el
(cl-defgeneric transient-format-description (obj)
  "Format OBJ's `description' for display and return the result.")