From 002f18c071d8b7c73c298448abbd0e8d3f463830 Mon Sep 17 00:00:00 2001 From: Developer Anonymous Date: Thu, 29 Aug 2024 14:33:43 +0200 Subject: [PATCH] Fix ScheduledEvent.users doc --- discord/scheduled_event.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/discord/scheduled_event.py b/discord/scheduled_event.py index b57b3c96f..4a02a3cdb 100644 --- a/discord/scheduled_event.py +++ b/discord/scheduled_event.py @@ -993,9 +993,8 @@ class ScheduledEvent(Hashable): after: Optional[Snowflake] = None, oldest_first: bool = MISSING, ) -> AsyncIterator[User]: - """|coro| - - Retrieves all :class:`User` that are subscribed to this event. + """Returns an :term:`asynchronous iterator` representing the users that have subscribed to + this event. This requires :attr:`Intents.members` to get information about members other than yourself. @@ -1005,9 +1004,9 @@ class ScheduledEvent(Hashable): HTTPException Retrieving the members failed. - Returns - -------- - List[:class:`User`] + Yields + ------ + :class:`User` All subscribed users of this event. """