Document Guild.bans breaking change in the migrating guide

3 years ago · f47568ee71
1 changed files with 16 additions and 0 deletions
--- a/docs/migrating.rst
+++ b/docs/migrating.rst
@ -921,6 +921,22 @@ This removes the following:
 - ``commands.StoreChannelConverter``
 - ``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
 ----------------------------