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

Document Guild.bans breaking change in the migrating guide

Browse Source
This commit is contained in:
Rapptz 2022-04-01 11:47:27 -04:00
parent e79895d824
commit f47568ee71
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/migrating.rst
View File

@ -921,6 +921,22 @@ This removes the following:
- ``commands.StoreChannelConverter`` - ``commands.StoreChannelConverter``
- ``ChannelType.store`` - ``ChannelType.store``
Change in ``Guild.bans`` endpoint
-----------------------------------
Due to a breaking API change by Discord, :meth:`Guild.bans` no longer returns a list of every ban in the guild but instead is paginated using an asynchronous iterator.
.. code-block:: python3
# before
bans = await guild.bans()
# after
async for ban in guild.bans(limit=1000):
...
Function Signature Changes Function Signature Changes
---------------------------- ----------------------------