Previous: , Up: Suffix Methods   [Contents][Index]


5.5.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.

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 doc string.

For suffixes, show the command’s doc string.

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