Update description from docs

This commit is contained in:
Alex Root Junior 2023-02-04 19:25:59 +02:00
parent 848c625b71
commit 701f6f845b
No known key found for this signature in database
GPG key ID: 074C1D455EBEA4AC
9 changed files with 31 additions and 31 deletions

View file

@ -9,9 +9,9 @@
"object": {
"anchor": "getchatmember",
"name": "getChatMember",
"description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description": "<p>Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description": "<p>Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"annotations": [
{
"type": "Integer or String",

View file

@ -2709,9 +2709,9 @@
"annotations": [
{
"type": "Integer",
"description": "Signed 32-bit identifier of the request",
"html_description": "<td>Signed 32-bit identifier of the request</td>",
"rst_description": "Signed 32-bit identifier of the request\n",
"description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message",
"html_description": "<td>Signed 32-bit identifier of the request, which will be received back in the <a href=\"#usershared\">UserShared</a> object. Must be unique within the message</td>",
"rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message\n",
"name": "request_id",
"required": true
},
@ -2743,9 +2743,9 @@
"annotations": [
{
"type": "Integer",
"description": "Signed 32-bit identifier of the request",
"html_description": "<td>Signed 32-bit identifier of the request</td>",
"rst_description": "Signed 32-bit identifier of the request\n",
"description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message",
"html_description": "<td>Signed 32-bit identifier of the request, which will be received back in the <a href=\"#chatshared\">ChatShared</a> object. Must be unique within the message</td>",
"rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n",
"name": "request_id",
"required": true
},
@ -2783,9 +2783,9 @@
},
{
"type": "ChatAdministratorRights",
"description": "A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.",
"html_description": "<td><em>Optional</em>. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.</td>",
"rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.\n",
"description": "A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.",
"html_description": "<td><em>Optional</em>. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of <em>bot_administrator_rights</em>. If not specified, no additional restrictions are applied.</td>",
"rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n",
"name": "user_administrator_rights",
"required": false
},
@ -7578,9 +7578,9 @@
{
"anchor": "getchatmember",
"name": "getChatMember",
"description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description": "<p>Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description": "Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description": "<p>Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"annotations": [
{
"type": "Integer or String",

View file

@ -15,9 +15,9 @@
"annotations": [
{
"type": "Integer",
"description": "Signed 32-bit identifier of the request",
"html_description": "<td>Signed 32-bit identifier of the request</td>",
"rst_description": "Signed 32-bit identifier of the request\n",
"description": "Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message",
"html_description": "<td>Signed 32-bit identifier of the request, which will be received back in the <a href=\"#chatshared\">ChatShared</a> object. Must be unique within the message</td>",
"rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n",
"name": "request_id",
"required": true
},
@ -55,9 +55,9 @@
},
{
"type": "ChatAdministratorRights",
"description": "A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.",
"html_description": "<td><em>Optional</em>. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.</td>",
"rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied.\n",
"description": "A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.",
"html_description": "<td><em>Optional</em>. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of <em>bot_administrator_rights</em>. If not specified, no additional restrictions are applied.</td>",
"rst_description": "*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n",
"name": "user_administrator_rights",
"required": false
},

View file

@ -15,9 +15,9 @@
"annotations": [
{
"type": "Integer",
"description": "Signed 32-bit identifier of the request",
"html_description": "<td>Signed 32-bit identifier of the request</td>",
"rst_description": "Signed 32-bit identifier of the request\n",
"description": "Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message",
"html_description": "<td>Signed 32-bit identifier of the request, which will be received back in the <a href=\"#usershared\">UserShared</a> object. Must be unique within the message</td>",
"rst_description": "Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message\n",
"name": "request_id",
"required": true
},

View file

@ -1486,9 +1486,9 @@ class Bot(ContextInstanceMixin["Bot"]):
ChatMemberBanned,
]:
"""
Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Source: https://core.telegram.org/bots/api#{'anchor': 'getchatmember', 'name': 'getChatMember', 'description': 'Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.', 'html_description': '<p>Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a <a href="#chatmember">ChatMember</a> object on success.</p>', 'rst_description': 'Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'html_description': '<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': '<td>Unique identifier of the target user</td>', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberOwner'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberAdministrator'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberMember'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberRestricted'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberLeft'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberBanned'}}]}}, 'bases': ['TelegramMethod']}
Source: https://core.telegram.org/bots/api#{'anchor': 'getchatmember', 'name': 'getChatMember', 'description': 'Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.', 'html_description': '<p>Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a <a href="#chatmember">ChatMember</a> object on success.</p>', 'rst_description': 'Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'html_description': '<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': '<td>Unique identifier of the target user</td>', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberOwner'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberAdministrator'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberMember'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberRestricted'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberLeft'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatMemberBanned'}}]}}, 'bases': ['TelegramMethod']}
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)
:param user_id: Unique identifier of the target user

View file

@ -29,7 +29,7 @@ class GetChatMember(
]
):
"""
Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Source: https://core.telegram.org/bots/api#getchatmember
"""

View file

@ -506,7 +506,7 @@ class Chat(TelegramObject):
- :code:`chat_id`
Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.
Source: https://core.telegram.org/bots/api#getchatmember

View file

@ -16,7 +16,7 @@ class KeyboardButtonRequestChat(TelegramObject):
"""
request_id: int
"""Signed 32-bit identifier of the request"""
"""Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message"""
chat_is_channel: bool
"""Pass :code:`True` to request a channel chat, pass :code:`False` to request a group or a supergroup chat."""
chat_is_forum: Optional[bool] = None
@ -26,7 +26,7 @@ class KeyboardButtonRequestChat(TelegramObject):
chat_is_created: Optional[bool] = None
"""*Optional*. Pass :code:`True` to request a chat owned by the user. Otherwise, no additional restrictions are applied."""
user_administrator_rights: Optional[ChatAdministratorRights] = None
"""*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. If not specified, no additional restrictions are applied."""
"""*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied."""
bot_administrator_rights: Optional[ChatAdministratorRights] = None
"""*Optional*. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of *user_administrator_rights*. If not specified, no additional restrictions are applied."""
bot_is_member: Optional[bool] = None

View file

@ -11,7 +11,7 @@ class KeyboardButtonRequestUser(TelegramObject):
"""
request_id: int
"""Signed 32-bit identifier of the request"""
"""Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.user_shared.UserShared` object. Must be unique within the message"""
user_is_bot: Optional[bool] = None
"""*Optional*. Pass :code:`True` to request a bot, pass :code:`False` to request a regular user. If not specified, no additional restrictions are applied."""
user_is_premium: Optional[bool] = None