Browse Source

Documenting that guild.chunk() returns list of members

pull/7510/head
Scrumpy (Jay) 3 years ago
committed by GitHub
parent
commit
3d0309ca4a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      discord/guild.py

7
discord/guild.py

@ -3325,7 +3325,7 @@ class Guild(Hashable):
await self._state.http.edit_widget(self.id, payload=payload)
async def chunk(self, *, cache: bool = True) -> None:
async def chunk(self, *, cache: bool = True) -> Optional[List[Member]]:
"""|coro|
Requests all members that belong to this guild. In order to use this,
@ -3344,6 +3344,11 @@ class Guild(Hashable):
-------
ClientException
The members intent is not enabled.
Returns
--------
Optional[List[:class:`Member`]]
Returns a list of all the members in the guild.
"""
if not self._state._intents.members:

Loading…
Cancel
Save