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

Cleanup docstrings and add some entries to the docs

Browse Source
This commit is contained in:
Dan 2018-04-29 19:24:06 +02:00
parent d3472fd052
commit 2c253b2fbc
2 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/pyrogram/Client.rst
View File

@ -15,6 +15,7 @@ Client
stop stop
idle idle
on_message on_message
on_callback_query
on_raw_update on_raw_update
add_handler add_handler
send send
@ -25,6 +26,7 @@ Client
send_photo send_photo
send_audio send_audio
send_document send_document
send_sticker
send_video send_video
send_voice send_voice
send_video_note send_video_note
@ -33,11 +35,11 @@ Client
send_venue send_venue
send_contact send_contact
send_chat_action send_chat_action
send_sticker
download_media download_media
get_user_profile_photos get_user_profile_photos
edit_message_text edit_message_text
edit_message_caption edit_message_caption
edit_message_reply_markup
delete_messages delete_messages
join_chat join_chat
leave_chat leave_chat
@ -49,4 +51,6 @@ Client
delete_contacts delete_contacts
get_inline_bot_results get_inline_bot_results
send_inline_bot_result send_inline_bot_result
get_messages get_users
get_messages
answer_callback_query

36
pyrogram/client/client.py
View File

@ -1174,8 +1174,8 @@ class Client:
Returns: Returns:
On success and in case *message_ids* was a list, the returned value will be a list of the forwarded On success and in case *message_ids* was a list, the returned value will be a list of the forwarded
:obj:`Messages <pyrogram.api.types.pyrogram.Message>` even if a list contains just one element, otherwise if :obj:`Messages <pyrogram.Message>` even if a list contains just one element, otherwise if
*message_ids* was an integer, the single forwarded :obj:`Message <pyrogram.api.types.pyrogram.Message>` *message_ids* was an integer, the single forwarded :obj:`Message <pyrogram.Message>`
is returned. is returned.
Raises: Raises:
@ -1268,7 +1268,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -1403,7 +1403,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -1530,7 +1530,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -1642,7 +1642,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -1785,7 +1785,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -1919,7 +1919,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2042,7 +2042,7 @@ class Client:
The size of the file. The size of the file.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2284,7 +2284,7 @@ class Client:
instructions to remove reply keyboard or to force a reply from the user. instructions to remove reply keyboard or to force a reply from the user.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2359,7 +2359,7 @@ class Client:
instructions to remove reply keyboard or to force a reply from the user. instructions to remove reply keyboard or to force a reply from the user.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2431,7 +2431,7 @@ class Client:
instructions to remove reply keyboard or to force a reply from the user. instructions to remove reply keyboard or to force a reply from the user.
Returns: Returns:
On success, the sent :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the sent :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2567,7 +2567,7 @@ class Client:
An InlineKeyboardMarkup object. An InlineKeyboardMarkup object.
Returns: Returns:
On success, the edited :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the edited :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2621,7 +2621,7 @@ class Client:
An InlineKeyboardMarkup object. An InlineKeyboardMarkup object.
Returns: Returns:
On success, the edited :obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned. On success, the edited :obj:`Message <pyrogram.Message>` is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -2665,7 +2665,7 @@ class Client:
Returns: Returns:
On success, if edited message is sent by the bot, the edited On success, if edited message is sent by the bot, the edited
:obj:`Message <pyrogram.api.types.pyrogram.Message>` is returned, otherwise True is returned. :obj:`Message <pyrogram.Message>` is returned, otherwise True is returned.
Raises: Raises:
:class:`Error <pyrogram.Error>` :class:`Error <pyrogram.Error>`
@ -3261,7 +3261,7 @@ class Client:
"""Use this method to download the media from a Message. """Use this method to download the media from a Message.
Args: Args:
message (:obj:`Message <pyrogram.api.types.pyrogram.Message>` | ``str``): message (:obj:`Message <pyrogram.Message>` | ``str``):
Pass a Message containing the media, the media itself (message.audio, message.video, ...) or Pass a Message containing the media, the media itself (message.audio, message.video, ...) or
the file id as string. the file id as string.
@ -3549,8 +3549,8 @@ class Client:
Returns: Returns:
On success and in case *message_ids* was a list, the returned value will be a list of the requested On success and in case *message_ids* was a list, the returned value will be a list of the requested
:obj:`Messages <pyrogram.api.types.pyrogram.Message>` even if a list contains just one element, otherwise if :obj:`Messages <pyrogram.Message>` even if a list contains just one element, otherwise if
*message_ids* was an integer, the single requested :obj:`Message <pyrogram.api.types.pyrogram.Message>` *message_ids* was an integer, the single requested :obj:`Message <pyrogram.Message>`
is returned. is returned.
Raises: Raises: