From 4926eda4c5a9bd1de482a2f94ae28d048bee4de9 Mon Sep 17 00:00:00 2001 From: wulan17 Date: Sat, 8 Mar 2025 20:16:00 +0700 Subject: [PATCH] pyrofork: docs: Add warning regarding markdown text formatting Signed-off-by: wulan17 --- docs/source/topics/text-formatting.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/topics/text-formatting.rst b/docs/source/topics/text-formatting.rst index 10772e8a..8c178ece 100644 --- a/docs/source/topics/text-formatting.rst +++ b/docs/source/topics/text-formatting.rst @@ -47,6 +47,12 @@ list of the basic styles currently supported by Pyrofork. Markdown Style -------------- +.. warning:: + + The Markdown style is not recommended for complex text formatting. + If you want to use complex text formatting such as nested entities, overlapping entities use the HTML style instead. + + To strictly use this mode, pass :obj:`~pyrogram.enums.ParseMode.MARKDOWN` to the *parse_mode* parameter when using :meth:`~pyrogram.Client.send_message`. Use the following syntax in your message: @@ -230,7 +236,7 @@ strike` styles, and you can still combine both Markdown and HTML together. Here there are some example texts you can try sending: -**Markdown**: +**Markdown (Not Recommended)**: - ``**bold, --underline--**`` - ``**bold __italic --underline ~~strike~~--__**``