Function: transient-describe

transient-describe is an interactive and byte-compiled function defined in transient.el.

Signature

(transient-describe)

Documentation

From a transient menu, describe something in another buffer.

This command can be bound multiple times to describe different targets. Each binding must specify the thing it describes, by setting the value of its target slot, using the keyword argument :=.

The helper slot specifies the low-level function used to describe the target, and can be omitted, in which case transient--describe-function is used for a symbol, transient--show-manual is used for a string beginning with a parenthesis, and transient--show-manpage is used for any other string.

For example:
  [("e" "about emacs" transient-describe := "(emacs)")
   ("g" "about git" transient-describe := "git")]

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/transient-20260414.1009/transient.el
(transient-define-suffix transient-describe ()
  "From a transient menu, describe something in another buffer.

This command can be bound multiple times to describe different targets.
Each binding must specify the thing it describes, by setting the value
of its `target' slot, using the keyword argument `:='.

The `helper' slot specifies the low-level function used to describe the
target, and can be omitted, in which case `transient--describe-function'
is used for a symbol, `transient--show-manual' is used for a string
beginning with a parenthesis, and `transient--show-manpage' is used for
any other string.

For example:
  [(\"e\" \"about emacs\" transient-describe := \"(emacs)\")
   (\"g\" \"about git\"   transient-describe := \"git\")]"
  :class 'transient-describe-target
  (interactive)
  (with-slots (helper target) (transient-suffix-object)
    (transient--display-help helper target)))