Skip to content

Commit a55bb1e

Browse files
committed
Added deprecation note to apply_style attribute of pwarning()
1 parent 100ed9f commit a55bb1e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

cmd2/cmd2.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,8 +1160,12 @@ def pwarning(
11601160
11611161
:param msg: object to print
11621162
:param end: string appended after the end of the message, default a newline
1163-
:param apply_style: If True, then ansi.style_warning will be applied to the message text. Set to False in cases
1164-
where the message text already has the desired style. Defaults to True.
1163+
:param apply_style:
1164+
If True, then ansi.style_warning will be applied to the message text. Set to False in cases
1165+
where the message text already has the desired style. Defaults to True.
1166+
1167+
.. deprecated: 2.4.4
1168+
Use :meth:`~cmd2.Cmd.print_to` instead to print to stderr without style applied.
11651169
:param paged: If True, pass the output through the configured pager.
11661170
:param chop: If paged is True, True to truncate long lines or False to wrap long lines.
11671171
"""

0 commit comments

Comments
 (0)