Skip to content

Commit dcf83a3

Browse files
committed
Updating docs for default style functions
1 parent 8914dd5 commit dcf83a3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

cmd2/ansi.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,13 +198,13 @@ def style(text: Any, *, fg: str = '', bg: str = '', bold: bool = False,
198198
# These can be altered to suit an application's needs and only need to be a
199199
# function with the following structure: func(str) -> str
200200
style_success = functools.partial(style, fg='green')
201-
"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` to generate bold green text"""
201+
"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` which colors text to signify success"""
202202

203203
style_warning = functools.partial(style, fg='bright_yellow')
204-
"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` to generate yellow text"""
204+
"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` which colors text to signify a warning"""
205205

206206
style_error = functools.partial(style, fg='bright_red')
207-
"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` to generate bright red text"""
207+
"""Partial function supplying arguments to :meth:`cmd2.ansi.style()` which colors text to signify an error"""
208208

209209

210210
def async_alert_str(*, terminal_columns: int, prompt: str, line: str, cursor_offset: int, alert_msg: str) -> str:

0 commit comments

Comments
 (0)