mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 04:17:16 +00:00
Code Issues Projects Releases Wiki Activity

Fix documentation errors in discord.Invite and on_integration_update

Browse Source
This commit is contained in:
Andy 2022-06-01 07:36:51 +01:00 committed by GitHub
parent 59ebfefbf4
commit 6a4d5eef52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
discord/invite.py
View File

@ -295,23 +295,23 @@ class Invite(Hashable):
Attributes Attributes
----------- -----------
max_age: :class:`int` max_age: Optional[:class:`int`]
How long before the invite expires in seconds. How long before the invite expires in seconds.
A value of ``0`` indicates that it doesn't expire. A value of ``0`` indicates that it doesn't expire.
code: :class:`str` code: :class:`str`
The URL fragment used for the invite. The URL fragment used for the invite.
guild: Optional[Union[:class:`Guild`, :class:`Object`, :class:`PartialInviteGuild`]] guild: Optional[Union[:class:`Guild`, :class:`Object`, :class:`PartialInviteGuild`]]
The guild the invite is for. Can be ``None`` if it's from a group direct message. The guild the invite is for. Can be ``None`` if it's from a group direct message.
revoked: :class:`bool` revoked: Optional[:class:`bool`]
Indicates if the invite has been revoked. Indicates if the invite has been revoked.
created_at: :class:`datetime.datetime` created_at: Optional[:class:`datetime.datetime`]
An aware UTC datetime object denoting the time the invite was created. An aware UTC datetime object denoting the time the invite was created.
temporary: :class:`bool` temporary: Optional[:class:`bool`]
Indicates that the invite grants temporary membership. Indicates that the invite grants temporary membership.
If ``True``, members who joined via this invite will be kicked upon disconnect. If ``True``, members who joined via this invite will be kicked upon disconnect.
uses: :class:`int` uses: Optional[:class:`int`]
How many times the invite has been used. How many times the invite has been used.
max_uses: :class:`int` max_uses: Optional[:class:`int`]
How many times the invite can be used. How many times the invite can be used.
A value of ``0`` indicates that it has unlimited uses. A value of ``0`` indicates that it has unlimited uses.
inviter: Optional[:class:`User`] inviter: Optional[:class:`User`]
@ -327,7 +327,7 @@ class Invite(Hashable):
.. versionadded:: 2.0 .. versionadded:: 2.0
channel: Union[:class:`abc.GuildChannel`, :class:`Object`, :class:`PartialInviteChannel`] channel: Optional[Union[:class:`abc.GuildChannel`, :class:`Object`, :class:`PartialInviteChannel`]]
The channel the invite is for. The channel the invite is for.
target_type: :class:`InviteTarget` target_type: :class:`InviteTarget`
The type of target for the voice channel invite. The type of target for the voice channel invite.

2
docs/api.rst
View File

@ -615,7 +615,7 @@ Integrations
.. versionadded:: 2.0 .. versionadded:: 2.0
:param integration: The integration that was created. :param integration: The integration that was updated.
:type integration: :class:`Integration` :type integration: :class:`Integration`
.. function:: on_guild_integrations_update(guild) .. function:: on_guild_integrations_update(guild)