Skip to content

Commit

Permalink
Update missing links in the documentation summary
Browse files Browse the repository at this point in the history
  • Loading branch information
Lonami committed Sep 24, 2019
1 parent 40aa46e commit d1ddfd0
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 0 deletions.
5 changes: 5 additions & 0 deletions readthedocs/quick-references/objects-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 121,7 @@ Methods
delete
get_reply_message
click
mark_read
pin
download_media
get_entities_text
Expand All @@ -142,6 143,8 @@ its name, bot-API style file ID, etc.

id
name
ext
mime_type
width
height
size
Expand Down Expand Up @@ -176,6 179,7 @@ It bases `ChatGetter <telethon.tl.custom.chatgetter.ChatGetter>`.
wait_read
wait_event
cancel
cancel_all


AdminLogEvent
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions telethon/client/messages.py
Original file line number Diff line number Diff line change
Expand Up @@ -1122,6 1122,8 @@ async def send_read_acknowledge(
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() <telethon.tl.custom.message.Message.mark_read>`.
Arguments
entity (`entity`):
The chat where these messages are located.
Expand Down
6 changes: 6 additions & 0 deletions telethon/tl/custom/conversation.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 250,12 @@ async def wait_event(self, event, *, timeout=None):
"""
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:
Expand Down
8 changes: 8 additions & 0 deletions telethon/tl/custom/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 22,14 @@ def __init__(self, media):
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)

Expand Down

0 comments on commit d1ddfd0

Please sign in to comment.