diff options
| author | Maya <[email protected]> | 2021-02-21 18:12:30 +1300 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-02-21 00:12:30 -0500 |
| commit | 66b834b3323c8d9403b2cb8f29b2e00d633bb1cc (patch) | |
| tree | e585d75d13485db234dc9f81886fb5ea096024ea /docs | |
| parent | Document behavior of on_disconnect (diff) | |
| download | discord.py-66b834b3323c8d9403b2cb8f29b2e00d633bb1cc.tar.xz discord.py-66b834b3323c8d9403b2cb8f29b2e00d633bb1cc.zip | |
Document BanEntry
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 16 |
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 ~~~~~~~~~~~~ |