Update some inconsistent docstrings

This commit is contained in:
Dan 2018-05-09 13:04:02 +02:00
parent 07965850bf
commit 06e6579091
6 changed files with 12 additions and 9 deletions

View File

@ -40,7 +40,7 @@ class GetMessages(BaseClient):
Iterators and Generators are also accepted.
replies (``int``, *optional*):
The number of replies to get for each message. Defaults to 1.
The number of subsequent replies to get for each message. Defaults to 1.
Returns:
On success and in case *message_ids* was a list, the returned value will be a list of the requested

View File

@ -42,7 +42,7 @@ class SendMessage(BaseClient):
text (``str``):
Text of the message to be sent.
parse_mode (``str``):
parse_mode (``str``, *optional*):
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 message.
Defaults to Markdown.
@ -54,7 +54,7 @@ class SendMessage(BaseClient):
Sends the message silently.
Users will receive a notification with no sound.
reply_to_message_id (``bool``, *optional*):
reply_to_message_id (``int``, *optional*):
If the message is a reply, ID of the original message.
reply_markup (:obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply`, *optional*):

View File

@ -42,12 +42,12 @@ class EditMessageCaption(BaseClient):
caption (``str``):
New caption of the message.
parse_mode (``str``):
parse_mode (``str``, *optional*):
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.
Defaults to Markdown.
reply_markup (:obj:`InlineKeyboardMarkup`):
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
Returns:

View File

@ -37,7 +37,7 @@ class EditMessageReplyMarkup(BaseClient):
message_id (``int``):
Message identifier in the chat specified in chat_id.
reply_markup (:obj:`InlineKeyboardMarkup`):
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
Returns:

View File

@ -43,7 +43,7 @@ class EditMessageText(BaseClient):
text (``str``):
New text of the message.
parse_mode (``str``):
parse_mode (``str``, *optional*):
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 message.
Defaults to Markdown.
@ -51,7 +51,7 @@ class EditMessageText(BaseClient):
disable_web_page_preview (``bool``, *optional*):
Disables link previews for links in this message.
reply_markup (:obj:`InlineKeyboardMarkup`):
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
Returns:

View File

@ -29,7 +29,10 @@ class GetUserProfilePhotos(BaseClient):
Args:
user_id (``int`` | ``str``):
Unique identifier of the target user.
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
For a private channel/supergroup you can use its *t.me/joinchat/* link.
offset (``int``, *optional*):
Sequential number of the first photo to be returned.