diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-06-28 01:15:56 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-06-28 01:15:56 -0400 |
| commit | 8b49dea5166b11fed6c6206e95119ae00dc8ea20 (patch) | |
| tree | 536f4152700292907d5ec2568e0ba22c12d7adc3 /cmd2 | |
| parent | 9420bb387e8031a8d4a3078c6a17025780e27bf0 (diff) | |
| download | cmd2-git-8b49dea5166b11fed6c6206e95119ae00dc8ea20.tar.gz | |
Minor fix to docstring of ansi.style()
Diffstat (limited to 'cmd2')
| -rw-r--r-- | cmd2/ansi.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/cmd2/ansi.py b/cmd2/ansi.py index 081e28b7..035991bb 100644 --- a/cmd2/ansi.py +++ b/cmd2/ansi.py @@ -138,8 +138,8 @@ def style(text: Any, *, fg: str = '', bg: str = '', bold: bool = False, underlin to undo whatever styling was done at the beginning. :param text: Any object compatible with str.format() - :param fg: foreground color. Expects color names in FG_COLORS (e.g. 'red'). Defaults to no color. - :param bg: background color. Expects color names in BG_COLORS (e.g. 'black'). Defaults to no color. + :param fg: foreground color. Relies on `fg_lookup()` to retrieve ANSI escape based on name. Defaults to no color. + :param bg: background color. Relies on `bg_lookup()` to retrieve ANSI escape based on name. Defaults to no color. :param bold: apply the bold style if True. Defaults to False. :param underline: apply the underline style if True. Defaults to False. :return: the stylized string |