Update CallbackQuery docstrings (#1818)

* mark chat_instance as required

* change ordering and add bot
This commit is contained in:
Pietu R 2020-03-28 16:52:37 +02:00 committed by GitHub
parent 2d3357bfeb
commit e86ae25a62
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 8 deletions

View file

@ -36,6 +36,7 @@ The following wonderful people contributed directly or indirectly to this projec
- `Evan Haberecht <https://github.com/habereet>`_ - `Evan Haberecht <https://github.com/habereet>`_
- `evgfilim1 <https://github.com/evgfilim1>`_ - `evgfilim1 <https://github.com/evgfilim1>`_
- `franciscod <https://github.com/franciscod>`_ - `franciscod <https://github.com/franciscod>`_
- `gamgi <https://github.com/gamgi>`_
- `Hugo Damer <https://github.com/HakimusGIT>`_ - `Hugo Damer <https://github.com/HakimusGIT>`_
- `ihoru <https://github.com/ihoru>`_ - `ihoru <https://github.com/ihoru>`_
- `Jasmin Bom <https://github.com/jsmnbom>`_ - `Jasmin Bom <https://github.com/jsmnbom>`_

View file

@ -36,30 +36,31 @@ class CallbackQuery(TelegramObject):
Attributes: Attributes:
id (:obj:`str`): Unique identifier for this query. id (:obj:`str`): Unique identifier for this query.
from_user (:class:`telegram.User`): Sender. from_user (:class:`telegram.User`): Sender.
chat_instance (:obj:`str`): Global identifier, uniquely corresponding to the chat to which
the message with the callback button was sent.
message (:class:`telegram.Message`): Optional. Message with the callback button that message (:class:`telegram.Message`): Optional. Message with the callback button that
originated the query. originated the query.
data (:obj:`str`): Optional. Data associated with the callback button.
inline_message_id (:obj:`str`): Optional. Identifier of the message sent via the bot in inline_message_id (:obj:`str`): Optional. Identifier of the message sent via the bot in
inline mode, that originated the query. inline mode, that originated the query.
chat_instance (:obj:`str`): Optional. Global identifier, uniquely corresponding to the chat
to which the message with the callback button was sent.
data (:obj:`str`): Optional. Data associated with the callback button.
game_short_name (:obj:`str`): Optional. Short name of a Game to be returned. game_short_name (:obj:`str`): Optional. Short name of a Game to be returned.
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
Args: Args:
id (:obj:`str`): Unique identifier for this query. id (:obj:`str`): Unique identifier for this query.
from_user (:class:`telegram.User`): Sender. from_user (:class:`telegram.User`): Sender.
chat_instance (:obj:`str`): Global identifier, uniquely corresponding to the chat to which
the message with the callback button was sent. Useful for high scores in games.
message (:class:`telegram.Message`, optional): Message with the callback button that message (:class:`telegram.Message`, optional): Message with the callback button that
originated the query. Note that message content and message date will not be available originated the query. Note that message content and message date will not be available
if the message is too old. if the message is too old.
inline_message_id (:obj:`str`, optional): Identifier of the message sent via the bot in
inline mode, that originated the query.
chat_instance (:obj:`str`, optional): Global identifier, uniquely corresponding to the chat
to which the message with the callback button was sent. Useful for high scores in
games.
data (:obj:`str`, optional): Data associated with the callback button. Be aware that a bad data (:obj:`str`, optional): Data associated with the callback button. Be aware that a bad
client can send arbitrary data in this field. client can send arbitrary data in this field.
inline_message_id (:obj:`str`, optional): Identifier of the message sent via the bot in
inline mode, that originated the query.
game_short_name (:obj:`str`, optional): Short name of a Game to be returned, serves as game_short_name (:obj:`str`, optional): Short name of a Game to be returned, serves as
the unique identifier for the game the unique identifier for the game
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
Note: Note:
After the user presses an inline button, Telegram clients will display a progress bar After the user presses an inline button, Telegram clients will display a progress bar