From d9c6286044808448ddd30f9453230540c869f0c5 Mon Sep 17 00:00:00 2001 From: wulan17 Date: Mon, 2 Sep 2024 20:23:19 +0700 Subject: [PATCH] pyrofork: Add example(s) to translate_message_text method Signed-off-by: wulan17 --- pyrogram/methods/messages/translate_text.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/pyrogram/methods/messages/translate_text.py b/pyrogram/methods/messages/translate_text.py index 781a5879..92c967be 100644 --- a/pyrogram/methods/messages/translate_text.py +++ b/pyrogram/methods/messages/translate_text.py @@ -56,6 +56,22 @@ class TranslateText: entities (List of :obj:`~pyrogram.types.MessageEntity`): List of special entities that appear in message text, which can be specified instead of *parse_mode*. + Example: + .. code-block:: python + + # Using chat_id and message_ids + await app.translate_message_text("en", chat_id, message_ids) + + # Using text + await app.translate_message_text("en", text="Hello, how are you?") + + # Using text with parse_mode + await app.translate_message_text("en", text="*Hello*, how are you?", parse_mode=ParseMode.MARKDOWN) + + # Using text with entities + entities = [types.MessageEntityBold(offset=0, length=5)] + await app.translate_message_text("en", text="*Hello*, how are you?", entities=entities) + Returns: :obj:`~pyrogram.types.TranslatedText` | List of :obj:`~pyrogram.types.TranslatedText`: In case *message_ids* was not a list, a single result is returned, otherwise a list of results is returned.