aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 35da0571..9146b318 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -2867,6 +2867,22 @@ Guild
.. automethod:: audit_logs
:async-for:
+.. class:: BanEntry
+
+ A namedtuple which represents a ban returned from :meth:`~Guild.bans`.
+
+ .. attribute:: reason
+
+ The reason this user was banned.
+
+ :type: Optional[:class:`str`]
+ .. attribute:: user
+
+ The :class:`User` that was banned.
+
+ :type: :class:`User`
+
+
Integration
~~~~~~~~~~~~