releso.exceptions.underline

releso.exceptions.underline(message: str) → str

Underline the string.

If ANSI styling is available the message is styled by an underscore and bold. After the message the styling is removed again.

For more information please see ReLeSO.exceptions.output_styling().

Parameters:

message (str) – string to strike through

Returns:

ANSI encoded struck through message.

Return type:

(str)