Skip to content

Commit 57e599a

Browse files
authored
📝 Update the docstring of the _make_rich_text method (#972)
1 parent 990efec commit 57e599a

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

typer/rich_utils.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,9 @@ def _make_rich_text(
149149
) -> Union[Markdown, Text]:
150150
"""Take a string, remove indentations, and return styled text.
151151
152-
By default, return the text as a Rich Text with the request style.
153-
If `rich_markdown_enable` is `True`, also parse the text for Rich markup strings.
154-
If `rich_markup_enable` is `True`, parse as Markdown.
155-
156-
Only one of `rich_markdown_enable` or `rich_markup_enable` can be True.
157-
If both are True, `rich_markdown_enable` takes precedence.
152+
By default, the text is not parsed for any special formatting.
153+
If `markup_mode` is `"rich"`, the text is parsed for Rich markup strings.
154+
If `markup_mode` is `"markdown"`, parse as Markdown.
158155
"""
159156
# Remove indentations from input text
160157
text = inspect.cleandoc(text)

0 commit comments

Comments
 (0)