mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-28 21:07:59 +00:00
Code Issues Releases Wiki Activity

Update docstrings

Browse Source
This commit is contained in:
Dan 2018-03-14 10:59:35 +01:00
parent f997e97494
commit 7beb611cea
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
pyrogram/client/client.py
View File

@ -513,16 +513,16 @@ class Client:
update (:obj:`Update`): update (:obj:`Update`):
The received update, which can be one of the many single Updates listed in the *updates* The received update, which can be one of the many single Updates listed in the *updates*
field you see in the :obj:`types.Update <pyrogram.api.types.Update>` type. field you see in the :obj:`Update <pyrogram.api.types.Update>` type.
users (:obj:`dict`): users (:obj:`dict`):
Dictionary of all :obj:`types.User <pyrogram.api.types.User>` mentioned in the update. Dictionary of all :obj:`User <pyrogram.api.types.User>` mentioned in the update.
You can access extra info about the user (such as *first_name*, *last_name*, etc...) by using You can access extra info about the user (such as *first_name*, *last_name*, etc...) by using
the IDs you find in the *update* argument (e.g.: *users[1768841572]*). the IDs you find in the *update* argument (e.g.: *users[1768841572]*).
chats (:obj:`dict`): chats (:obj:`dict`):
Dictionary of all :obj:`types.Chat <pyrogram.api.types.Chat>` and Dictionary of all :obj:`Chat <pyrogram.api.types.Chat>` and
:obj:`types.Channel <pyrogram.api.types.Channel>` mentioned in the update. :obj:`Channel <pyrogram.api.types.Channel>` mentioned in the update.
You can access extra info about the chat (such as *title*, *participants_count*, etc...) You can access extra info about the chat (such as *title*, *participants_count*, etc...)
by using the IDs you find in the *update* argument (e.g.: *chats[1701277281]*). by using the IDs you find in the *update* argument (e.g.: *chats[1701277281]*).
@ -530,10 +530,10 @@ class Client:
The following Empty or Forbidden types may exist inside the *users* and *chats* dictionaries. The following Empty or Forbidden types may exist inside the *users* and *chats* dictionaries.
They mean you have been blocked by the user or banned from the group/channel. They mean you have been blocked by the user or banned from the group/channel.
- :obj:`types.UserEmpty <pyrogram.api.types.UserEmpty>` - :obj:`UserEmpty <pyrogram.api.types.UserEmpty>`
- :obj:`types.ChatEmpty <pyrogram.api.types.ChatEmpty>` - :obj:`ChatEmpty <pyrogram.api.types.ChatEmpty>`
- :obj:`types.ChatForbidden <pyrogram.api.types.ChatForbidden>` - :obj:`ChatForbidden <pyrogram.api.types.ChatForbidden>`
- :obj:`types.ChannelForbidden <pyrogram.api.types.ChannelForbidden>` - :obj:`ChannelForbidden <pyrogram.api.types.ChannelForbidden>`
""" """
self.update_handler = callback self.update_handler = callback
@ -2742,7 +2742,7 @@ class Client:
Useful for location-based results only. Useful for location-based results only.
Returns: Returns:
On Success, `BotResults <pyrogram.api.types.messages.BotResults>`_ is returned. On Success, :obj:`BotResults <pyrogram.api.types.messages.BotResults>`_ is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`pyrogram.Error`