Add example for Client.purge_from

2016-05-12 09:05:51 -04:00 · 2016-05-12 09:05:51 -04:00 · 92175ea152
commit 92175ea152
parent 493bffc685
1 changed files with 12 additions and 1 deletions
--- a/discord/client.py
+++ b/discord/client.py
@ -1062,6 +1062,17 @@ class Client:
        HTTPException
            Purging the messages failed.

+        Examples
+        ---------
+
+        Deleting bot's messages ::
+
+            def is_me(m):
+                return m.author == client.user
+
+            deleted = await client.purge_from(channel, limit=100, check=is_me)
+            await client.send_message(channel, 'Deleted {} message(s)'.format(len(deleted)))
+
        Returns
        --------
        list