Skip to content

Commit 0e016be

Browse files
committed
Clarify some docstrings around BulkBanResponse
1 parent ded9c5d commit 0e016be

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Diff for: discord/guild.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3814,7 +3814,7 @@ async def bulk_ban(
38143814
38153815
Parameters
38163816
-----------
3817-
users: :class:`abc.Snowflake`
3817+
users: Iterable[:class:`abc.Snowflake`]
38183818
The user to ban from their guild.
38193819
delete_message_seconds: :class:`int`
38203820
The number of seconds worth of messages to delete from the user

Diff for: docs/api.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -4499,14 +4499,14 @@ Guild
44994499

45004500
.. attribute:: banned
45014501

4502-
The list of users that were banned. The type of the list is a :class:`Object`
4503-
representing the user.
4502+
The list of users that were banned. The inner :class:`Object` of the list
4503+
has the :attr:`Object.type` set to :class:`User`.
45044504

45054505
:type: List[:class:`Object`]
45064506
.. attribute:: failed
45074507

4508-
The list of users that could not be banned. The type of the list is a :class:`Object`
4509-
representing the user.
4508+
The list of users that could not be banned. The inner :class:`Object` of the list
4509+
has the :attr:`Object.type` set to :class:`User`.
45104510

45114511
:type: List[:class:`Object`]
45124512

0 commit comments

Comments
 (0)