---

5.6.2 Suffix Format Methods ¶

Function: transient-format obj ¶

This generic function formats and returns OBJ for display.

When this function is called, then the current buffer is some temporary buffer. If you need the buffer from which the prefix command was invoked to be current, then do so by temporarily making transient--source-buffer current.

Function: transient-format-key obj ¶

This generic function formats OBJ’s key for display and returns the result.

Function: transient-format-description obj ¶

This generic function formats OBJ’s description for display and returns the result.

Function: transient-format-value obj ¶

This generic function formats OBJ’s value for display and returns the result.

Function: transient-show-help obj ¶

Show help for the prefix, infix or suffix command represented by OBJ.

Regardless of OBJ’s type, if its show-help slot is non-nil, that must be a function, which takes OBJ is its only argument. It must prepare, display and return a buffer, and select the window used to display it. The transient-show-help-window macro is intended for use in such functions.

For prefixes, show the info manual, if that is specified using the info-manual slot. Otherwise, show the manpage if that is specified using the man-page slot. Otherwise, show the command’s documentation string.

For suffixes, show the command’s documentation string.

For infixes, show the manpage if that is specified. Otherwise show the command’s documentation string.

Macro: transient-with-help-window &rest body ¶

Evaluate BODY, send output to *Help* buffer, and display it in a window. Select the help window, and make the help buffer current and return it.

Function: transient-show-summary obj &optional return ¶

This generic function shows or, if optional RETURN is non-nil, returns a brief summary about the command at point or hovered with the mouse.

This function is called when the mouse is moved over a command and (if the value of transient-enable-popup-navigation is verbose) when the user navigates to a command using the keyboard.

If OBJ’s summary slot is a string, that is used. If summary is a function, that is called with OBJ as the only argument and the returned string is used. If summary is or returns something other than a string or nil, no summary is shown. If summary is or returns nil, the first line of the documentation string is used, if any.

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