From d1ddfd09b604a8af4c64c5220ec42e4a90ae3c59 Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Tue, 24 Sep 2019 16:19:35 +0200 Subject: [PATCH] Update missing links in the documentation summary --- readthedocs/quick-references/objects-reference.rst | 5 +++++ telethon/client/messages.py | 2 ++ telethon/tl/custom/conversation.py | 6 ++++++ telethon/tl/custom/file.py | 8 ++++++++ 4 files changed, 21 insertions(+) diff --git a/readthedocs/quick-references/objects-reference.rst b/readthedocs/quick-references/objects-reference.rst index c8b2e876..972e4517 100644 --- a/readthedocs/quick-references/objects-reference.rst +++ b/readthedocs/quick-references/objects-reference.rst @@ -121,6 +121,7 @@ Methods delete get_reply_message click + mark_read pin download_media get_entities_text @@ -142,6 +143,8 @@ its name, bot-API style file ID, etc. id name + ext + mime_type width height size @@ -176,6 +179,7 @@ It bases `ChatGetter `. wait_read wait_event cancel + cancel_all AdminLogEvent @@ -236,6 +240,7 @@ These are the static methods you can use to create instances of the markup: inline switch_inline url + auth text request_location request_phone diff --git a/telethon/client/messages.py b/telethon/client/messages.py index 25bd4e6e..de9e7b75 100644 --- a/telethon/client/messages.py +++ b/telethon/client/messages.py @@ -1122,6 +1122,8 @@ class MessageMethods: If neither message nor maximum ID are provided, all messages will be marked as read by assuming that ``max_id = 0``. + See also `Message.mark_read() `. + Arguments entity (`entity`): The chat where these messages are located. diff --git a/telethon/tl/custom/conversation.py b/telethon/tl/custom/conversation.py index a1265b44..767ec95d 100644 --- a/telethon/tl/custom/conversation.py +++ b/telethon/tl/custom/conversation.py @@ -250,6 +250,12 @@ class Conversation(ChatGetter): """ Waits for a custom event to occur. Timeouts still apply. + .. note:: + + Only use this if there isn't another method available! + For example, don't use `wait_event` for new messages, + since `get_response` already exists, etc. + Unless you're certain that your code will run fast enough, generally you should get a "handle" of this special coroutine before acting. Generally, you should do this: diff --git a/telethon/tl/custom/file.py b/telethon/tl/custom/file.py index 0355d0e1..69e9ef50 100644 --- a/telethon/tl/custom/file.py +++ b/telethon/tl/custom/file.py @@ -22,6 +22,14 @@ class File: def id(self): """ The bot-API style ``file_id`` representing this file. + + .. note:: + + This file ID may not work under user accounts, + but should still be usable by bot accounts. + + You can, however, still use it to identify + a file in for example a database. """ return utils.pack_bot_file_id(self.media)