Fix some other method docstrings

This commit is contained in:
Dan 2018-05-09 12:47:11 +02:00
parent 746a0d0595
commit 07965850bf
5 changed files with 13 additions and 13 deletions

View File

@ -55,7 +55,7 @@ class SendPhoto(BaseClient):
caption (``bool``, *optional*): caption (``bool``, *optional*):
Photo caption, 0-200 characters. Photo caption, 0-200 characters.
parse_mode (``str``): parse_mode (``str``, *optional*):
Use :obj:`MARKDOWN <pyrogram.ParseMode.MARKDOWN>` or :obj:`HTML <pyrogram.ParseMode.HTML>` Use :obj:`MARKDOWN <pyrogram.ParseMode.MARKDOWN>` or :obj:`HTML <pyrogram.ParseMode.HTML>`
if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption. if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption.
Defaults to Markdown. Defaults to Markdown.
@ -76,12 +76,12 @@ class SendPhoto(BaseClient):
Additional interface options. An object for an inline keyboard, custom reply keyboard, Additional interface options. An object for an inline keyboard, custom reply keyboard,
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.
progress (``callable``): progress (``callable``, *optional*):
Pass a callback function to view the upload progress. Pass a callback function to view the upload progress.
The function must take *(client, current, total, \*args)* as positional arguments (look at the section The function must take *(client, current, total, \*args)* as positional arguments (look at the section
below for a detailed description). below for a detailed description).
progress_args (``tuple``): progress_args (``tuple``, *optional*):
Extra custom arguments for the progress callback function. Useful, for example, if you want to pass Extra custom arguments for the progress callback function. Useful, for example, if you want to pass
a chat_id and a message_id in order to edit a message with the updated progress. a chat_id and a message_id in order to edit a message with the updated progress.

View File

@ -60,12 +60,12 @@ class SendSticker(BaseClient):
Additional interface options. An object for an inline keyboard, custom reply keyboard, Additional interface options. An object for an inline keyboard, custom reply keyboard,
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.
progress (``callable``): progress (``callable``, *optional*):
Pass a callback function to view the upload progress. Pass a callback function to view the upload progress.
The function must take *(client, current, total, \*args)* as positional arguments (look at the section The function must take *(client, current, total, \*args)* as positional arguments (look at the section
below for a detailed description). below for a detailed description).
progress_args (``tuple``): progress_args (``tuple``, *optional*):
Extra custom arguments for the progress callback function. Useful, for example, if you want to pass Extra custom arguments for the progress callback function. Useful, for example, if you want to pass
a chat_id and a message_id in order to edit a message with the updated progress. a chat_id and a message_id in order to edit a message with the updated progress.

View File

@ -60,7 +60,7 @@ class SendVideo(BaseClient):
caption (``str``, *optional*): caption (``str``, *optional*):
Video caption, 0-200 characters. Video caption, 0-200 characters.
parse_mode (``str``): parse_mode (``str``, *optional*):
Use :obj:`MARKDOWN <pyrogram.ParseMode.MARKDOWN>` or :obj:`HTML <pyrogram.ParseMode.HTML>` Use :obj:`MARKDOWN <pyrogram.ParseMode.MARKDOWN>` or :obj:`HTML <pyrogram.ParseMode.HTML>`
if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption. if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption.
Defaults to Markdown. Defaults to Markdown.
@ -93,12 +93,12 @@ class SendVideo(BaseClient):
Additional interface options. An object for an inline keyboard, custom reply keyboard, Additional interface options. An object for an inline keyboard, custom reply keyboard,
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.
progress (``callable``): progress (``callable``, *optional*):
Pass a callback function to view the upload progress. Pass a callback function to view the upload progress.
The function must take *(client, current, total, \*args)* as positional arguments (look at the section The function must take *(client, current, total, \*args)* as positional arguments (look at the section
below for a detailed description). below for a detailed description).
progress_args (``tuple``): progress_args (``tuple``, *optional*):
Extra custom arguments for the progress callback function. Useful, for example, if you want to pass Extra custom arguments for the progress callback function. Useful, for example, if you want to pass
a chat_id and a message_id in order to edit a message with the updated progress. a chat_id and a message_id in order to edit a message with the updated progress.

View File

@ -69,12 +69,12 @@ class SendVideoNote(BaseClient):
Additional interface options. An object for an inline keyboard, custom reply keyboard, Additional interface options. An object for an inline keyboard, custom reply keyboard,
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.
progress (``callable``): progress (``callable``, *optional*):
Pass a callback function to view the upload progress. Pass a callback function to view the upload progress.
The function must take *(client, current, total, \*args)* as positional arguments (look at the section The function must take *(client, current, total, \*args)* as positional arguments (look at the section
below for a detailed description). below for a detailed description).
progress_args (``tuple``): progress_args (``tuple``, *optional*):
Extra custom arguments for the progress callback function. Useful, for example, if you want to pass Extra custom arguments for the progress callback function. Useful, for example, if you want to pass
a chat_id and a message_id in order to edit a message with the updated progress. a chat_id and a message_id in order to edit a message with the updated progress.

View File

@ -56,7 +56,7 @@ class SendVoice(BaseClient):
caption (``str``, *optional*): caption (``str``, *optional*):
Voice message caption, 0-200 characters. Voice message caption, 0-200 characters.
parse_mode (``str``): parse_mode (``str``, *optional*):
Use :obj:`MARKDOWN <pyrogram.ParseMode.MARKDOWN>` or :obj:`HTML <pyrogram.ParseMode.HTML>` Use :obj:`MARKDOWN <pyrogram.ParseMode.MARKDOWN>` or :obj:`HTML <pyrogram.ParseMode.HTML>`
if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption. if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption.
Defaults to Markdown. Defaults to Markdown.
@ -75,12 +75,12 @@ class SendVoice(BaseClient):
Additional interface options. An object for an inline keyboard, custom reply keyboard, Additional interface options. An object for an inline keyboard, custom reply keyboard,
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.
progress (``callable``): progress (``callable``, *optional*):
Pass a callback function to view the upload progress. Pass a callback function to view the upload progress.
The function must take *(client, current, total, \*args)* as positional arguments (look at the section The function must take *(client, current, total, \*args)* as positional arguments (look at the section
below for a detailed description). below for a detailed description).
progress_args (``tuple``): progress_args (``tuple``, *optional*):
Extra custom arguments for the progress callback function. Useful, for example, if you want to pass Extra custom arguments for the progress callback function. Useful, for example, if you want to pass
a chat_id and a message_id in order to edit a message with the updated progress. a chat_id and a message_id in order to edit a message with the updated progress.