Skip to content

Commit 53a5c0f

Browse files
committed
Updated _create_base_printing_console() docstring.
1 parent a206b3e commit 53a5c0f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

cmd2/cmd2.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1320,16 +1320,18 @@ def visible_prompt(self) -> str:
13201320

13211321
def _create_base_printing_console(
13221322
self,
1323+
*,
13231324
file: IO[str],
13241325
emoji: bool,
13251326
markup: bool,
13261327
highlight: bool,
13271328
) -> Cmd2BaseConsole:
13281329
"""Create a Cmd2BaseConsole with formatting overrides.
13291330
1330-
This works around a bug in Rich where complex renderables (like Table and Rule)
1331-
may not receive formatting settings passed directly to print() or log(). Passing
1332-
them to the constructor instead ensures they are correctly propagated.
1331+
This works around a bug in Rich where passing these formatting settings directly to
1332+
console.print() or console.log() does not always work when printing certain Renderables.
1333+
Passing them to the constructor instead ensures they are correctly propagated.
1334+
13331335
See: https://github.com/Textualize/rich/issues/4028
13341336
"""
13351337
return Cmd2BaseConsole(

0 commit comments

Comments
 (0)