From 9817310788f5b691cdeff94bbd98536a3b3a0ae5 Mon Sep 17 00:00:00 2001 From: Jasmin Bom Date: Wed, 30 Jan 2019 19:50:33 +0100 Subject: [PATCH] Reflow docstrings in replykeyboardmarkup to satisfy flake8 --- telegram/replykeyboardmarkup.py | 86 ++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/telegram/replykeyboardmarkup.py b/telegram/replykeyboardmarkup.py index 114e93454..c633a1e9c 100644 --- a/telegram/replykeyboardmarkup.py +++ b/telegram/replykeyboardmarkup.py @@ -101,20 +101,22 @@ class ReplyKeyboardMarkup(ReplyMarkup): Args: 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 - for optimal fit (e.g., make the keyboard smaller if there are just two rows of - buttons). Defaults to false, in which case the custom keyboard is always of the same - height as the app's standard keyboard. Defaults to ``False`` - one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as soon as - it's been used. The keyboard will still be available, but clients will automatically - display the usual letter-keyboard in the chat - the user can press a special button in - the input field to see the custom keyboard again. Defaults to ``False``. - selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard to - specific users only. Targets: + resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard + vertically for optimal fit (e.g., make the keyboard smaller if there are just two + rows of buttons). Defaults to false, in which case the custom keyboard is always of + the same height as the app's standard keyboard. + Defaults to ``False`` + one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as + soon as it's been used. The keyboard will still be available, but clients will + automatically display the usual letter-keyboard in the chat - the user can press + a special button in the input field to see the custom keyboard again. + 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 - 2) if the bot's message is a reply (has reply_to_message_id), sender of the original - message. + 2) if the bot's message is a reply (has reply_to_message_id), sender of the + original message. Defaults to ``False``. **kwargs (:obj:`dict`): Arbitrary keyword arguments. @@ -139,22 +141,24 @@ class ReplyKeyboardMarkup(ReplyMarkup): Return an ReplyKeyboardMarkup from a single row of KeyboardButtons Args: - button_row (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use in the - markup - resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard vertically - for optimal fit (e.g., make the keyboard smaller if there are just two rows of - buttons). Defaults to false, in which case the custom keyboard is always of the same - height as the app's standard keyboard. Defaults to ``False`` - one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as soon as - it's been used. The keyboard will still be available, but clients will automatically - display the usual letter-keyboard in the chat - the user can press a special button in - the input field to see the custom keyboard again. Defaults to ``False``. - selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard to - specific users only. Targets: + button_row (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use in + the markup + resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard + vertically for optimal fit (e.g., make the keyboard smaller if there are just two + rows of buttons). Defaults to false, in which case the custom keyboard is always of + the same height as the app's standard keyboard. + Defaults to ``False`` + one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as + soon as it's been used. The keyboard will still be available, but clients will + automatically display the usual letter-keyboard in the chat - the user can press + a special button in the input field to see the custom keyboard again. + 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 - 2) if the bot's message is a reply (has reply_to_message_id), sender of the original - message. + 2) if the bot's message is a reply (has reply_to_message_id), sender of the + original message. Defaults to ``False``. **kwargs (:obj:`dict`): Arbitrary keyword arguments. @@ -180,22 +184,24 @@ class ReplyKeyboardMarkup(ReplyMarkup): Return an ReplyKeyboardMarkup from a single column of KeyboardButtons Args: - button_column (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use in the - markup - resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard vertically - for optimal fit (e.g., make the keyboard smaller if there are just two rows of - buttons). Defaults to false, in which case the custom keyboard is always of the same - height as the app's standard keyboard. Defaults to ``False`` - one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as soon as - it's been used. The keyboard will still be available, but clients will automatically - display the usual letter-keyboard in the chat - the user can press a special button in - the input field to see the custom keyboard again. Defaults to ``False``. - selective (:obj:`bool`, optional): Use this parameter if you want to show the keyboard to - specific users only. Targets: + button_column (List[:class:`telegram.KeyboardButton` | :obj:`str`]): The button to use + in the markup + resize_keyboard (:obj:`bool`, optional): Requests clients to resize the keyboard + vertically for optimal fit (e.g., make the keyboard smaller if there are just two + rows of buttons). Defaults to false, in which case the custom keyboard is always of + the same height as the app's standard keyboard. + Defaults to ``False`` + one_time_keyboard (:obj:`bool`, optional): Requests clients to hide the keyboard as + soon as it's been used. The keyboard will still be available, but clients will + automatically display the usual letter-keyboard in the chat - the user can press + a special button in the input field to see the custom keyboard again. + 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 - 2) if the bot's message is a reply (has reply_to_message_id), sender of the original - message. + 2) if the bot's message is a reply (has reply_to_message_id), sender of the + original message. Defaults to ``False``. **kwargs (:obj:`dict`): Arbitrary keyword arguments.