diff options
author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-01-16 10:04:17 -0500 |
---|---|---|
committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-01-16 10:04:17 -0500 |
commit | dcf83a36a38b0aad650571d19da073d92b029382 (patch) | |
tree | 56b8c5ef3c6e2af82d5901a93abca3a92df00c93 /cmd2/ansi.py | |
parent | 8914dd5cbfc61d2f356a1a4f3049ec2aa5dd42b9 (diff) | |
download | cmd2-git-dcf83a36a38b0aad650571d19da073d92b029382.tar.gz |
Updating docs for default style functions
Diffstat (limited to 'cmd2/ansi.py')
-rw-r--r-- | cmd2/ansi.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/cmd2/ansi.py b/cmd2/ansi.py index 6ed51517..d3af525a 100644 --- a/cmd2/ansi.py +++ b/cmd2/ansi.py @@ -198,13 +198,13 @@ def style(text: Any, *, fg: str = '', bg: str = '', bold: bool = False, # These can be altered to suit an application's needs and only need to be a # function with the following structure: func(str) -> str style_success = functools.partial(style, fg='green') -"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` to generate bold green text""" +"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` which colors text to signify success""" style_warning = functools.partial(style, fg='bright_yellow') -"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` to generate yellow text""" +"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` which colors text to signify a warning""" style_error = functools.partial(style, fg='bright_red') -"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` to generate bright red text""" +"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` which colors text to signify an error""" def async_alert_str(*, terminal_columns: int, prompt: str, line: str, cursor_offset: int, alert_msg: str) -> str: |