OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-23 06:50:29 +01:00
Code Issues Projects Releases Packages Wiki Activity

Reflow docstrings in replykeyboardmarkup to satisfy flake8

Browse source
This commit is contained in:
Jasmin Bom 2019-01-30 19:50:33 +01:00
parent ed33c4a7a9
commit 9817310788
1 changed files with 46 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
telegram/replykeyboardmarkup.py
View file

@ -101,20 +101,22 @@ class ReplyKeyboardMarkup(ReplyMarkup):
Args: Args:
button (:class:`telegram.KeyboardButton` | :obj:`str`): The button to use in the markup button (:class:`telegram.KeyboardButton` | :obj:`str`): The button to use in the markup
resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard vertically resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard
for optimal fit (e.g., make the keyboard smaller if there are just two rows of vertically for optimal fit (e.g., make the keyboard smaller if there are just two
buttons). Defaults to false, in which case the custom keyboard is always of the same rows of buttons). Defaults to false, in which case the custom keyboard is always of
height as the app's standard keyboard. Defaults to ``False`` the same height as the app's standard keyboard.
one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as soon as Defaults to ``False``
it's been used. The keyboard will still be available, but clients will automatically one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as
display the usual letter-keyboard in the chat - the user can press a special button in soon as it's been used. The keyboard will still be available, but clients will
the input field to see the custom keyboard again. Defaults to ``False``. automatically display the usual letter-keyboard in the chat - the user can press
selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard to a special button in the input field to see the custom keyboard again.
specific users only. Targets: Defaults to ``False``.
selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object 1) users that are @mentioned in the text of the Message object
2) if the bot's message is a reply (has reply_to_message_id), sender of the original 2) if the bot's message is a reply (has reply_to_message_id), sender of the
message. original message.
Defaults to ``False``. Defaults to ``False``.
**kwargs (:obj:`dict`): Arbitrary keyword arguments. **kwargs (:obj:`dict`): Arbitrary keyword arguments.
@ -139,22 +141,24 @@ class ReplyKeyboardMarkup(ReplyMarkup):
Return an ReplyKeyboardMarkup from a single row of KeyboardButtons Return an ReplyKeyboardMarkup from a single row of KeyboardButtons
Args: Args:
button_row (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use in the button_row (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use in
markup the markup
resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard vertically resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard
for optimal fit (e.g., make the keyboard smaller if there are just two rows of vertically for optimal fit (e.g., make the keyboard smaller if there are just two
buttons). Defaults to false, in which case the custom keyboard is always of the same rows of buttons). Defaults to false, in which case the custom keyboard is always of
height as the app's standard keyboard. Defaults to ``False`` the same height as the app's standard keyboard.
one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as soon as Defaults to ``False``
it's been used. The keyboard will still be available, but clients will automatically one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as
display the usual letter-keyboard in the chat - the user can press a special button in soon as it's been used. The keyboard will still be available, but clients will
the input field to see the custom keyboard again. Defaults to ``False``. automatically display the usual letter-keyboard in the chat - the user can press
selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard to a special button in the input field to see the custom keyboard again.
specific users only. Targets: Defaults to ``False``.
selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object 1) users that are @mentioned in the text of the Message object
2) if the bot's message is a reply (has reply_to_message_id), sender of the original 2) if the bot's message is a reply (has reply_to_message_id), sender of the
message. original message.
Defaults to ``False``. Defaults to ``False``.
**kwargs (:obj:`dict`): Arbitrary keyword arguments. **kwargs (:obj:`dict`): Arbitrary keyword arguments.
@ -180,22 +184,24 @@ class ReplyKeyboardMarkup(ReplyMarkup):
Return an ReplyKeyboardMarkup from a single column of KeyboardButtons Return an ReplyKeyboardMarkup from a single column of KeyboardButtons
Args: Args:
button_column (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use in the button_column (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use
markup in the markup
resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard vertically resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard
for optimal fit (e.g., make the keyboard smaller if there are just two rows of vertically for optimal fit (e.g., make the keyboard smaller if there are just two
buttons). Defaults to false, in which case the custom keyboard is always of the same rows of buttons). Defaults to false, in which case the custom keyboard is always of
height as the app's standard keyboard. Defaults to ``False`` the same height as the app's standard keyboard.
one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as soon as Defaults to ``False``
it's been used. The keyboard will still be available, but clients will automatically one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as
display the usual letter-keyboard in the chat - the user can press a special button in soon as it's been used. The keyboard will still be available, but clients will
the input field to see the custom keyboard again. Defaults to ``False``. automatically display the usual letter-keyboard in the chat - the user can press
selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard to a special button in the input field to see the custom keyboard again.
specific users only. Targets: Defaults to ``False``.
selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard
to specific users only. Targets:
1) users that are @mentioned in the text of the Message object 1) users that are @mentioned in the text of the Message object
2) if the bot's message is a reply (has reply_to_message_id), sender of the original 2) if the bot's message is a reply (has reply_to_message_id), sender of the
message. original message.
Defaults to ``False``. Defaults to ``False``.
**kwargs (:obj:`dict`): Arbitrary keyword arguments. **kwargs (:obj:`dict`): Arbitrary keyword arguments.