Document BanEntry

2021-02-21 18:12:30 +13:00
parent b86073fac3
commit 66b834b332
2 changed files with 22 additions and 13 deletions
--- 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
 ~~~~~~~~~~~~