Browse Source

Document InviteUsersJob

pull/10386/head
Soheab 5 months ago
parent
commit
d9a74407b3
  1. 5
      discord/invite.py
  2. 8
      docs/api.rst

5
discord/invite.py

@ -47,6 +47,7 @@ __all__ = (
'PartialInviteChannel', 'PartialInviteChannel',
'PartialInviteGuild', 'PartialInviteGuild',
'Invite', 'Invite',
'InviteUsersJob',
) )
if TYPE_CHECKING: if TYPE_CHECKING:
@ -83,7 +84,7 @@ class InviteUsersJob:
----------- -----------
invite: :class:`Invite` invite: :class:`Invite`
The invite this job status is for. The invite this job status is for.
status: :class:`InviteTargetUsersJob` status: :class:`InviteUsersJobStatus`
The status of the job. The status of the job.
total_users: :class:`int` total_users: :class:`int`
The total number of users in the job. The total number of users in the job.
@ -688,7 +689,7 @@ class Invite(Hashable):
Returns Returns
-------- --------
:class:`InviteUsersJob` :class:`discord.InviteUsersJob`
The status of the target users job. The status of the target users job.
Raises Raises

8
docs/api.rst

@ -5526,6 +5526,14 @@ Invite
.. autoclass:: Invite() .. autoclass:: Invite()
:members: :members:
InviteUsersJob
~~~~~~~~~~~~~~
.. attributetable:: InviteUsersJob
.. autoclass:: InviteUsersJob()
:members:
Template Template
~~~~~~~~~ ~~~~~~~~~

Loading…
Cancel
Save