aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2017-05-06 16:24:14 -0400
committerRapptz <[email protected]>2017-05-06 16:39:47 -0400
commit7916878eb59cbf01e5beb55767e9e08fcfbfcff2 (patch)
treed8c12e9fb48ef5f99d388847f84b24b4526b3a72 /docs
parentReplace hasattr with try except in chunker. (diff)
downloaddiscord.py-7916878eb59cbf01e5beb55767e9e08fcfbfcff2.tar.xz
discord.py-7916878eb59cbf01e5beb55767e9e08fcfbfcff2.zip
Audit log role add and removes are lists, not single item.
Breaking change. role -> roles and it's now a list.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/api.rst b/docs/api.rst
index ae8ba412..255a20b9 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -915,7 +915,7 @@ All enumerations are subclasses of `enum`_.
Possible attributes for :class:`AuditLogDiff`:
- - :attr:`~AuditLogDiff.role`
+ - :attr:`~AuditLogDiff.roles`
.. attribute:: role_create
@@ -1375,12 +1375,12 @@ this goal, it must make use of a couple of data classes that aid in this goal.
a ``type`` attribute set to either ``'role'`` or ``'member'`` to help
decide what type of ID it is.
- .. attribute:: role
+ .. attribute:: roles
- *Union[:class:`Role`, :class:`Object`]* – A role being added or removed
+ *List[Union[:class:`Role`, :class:`Object`]]* – A list of roles being added or removed
from a member.
- If the role is not found then it is a :class:`Object` with the ID being
+ If a role is not found then it is a :class:`Object` with the ID being
filled in.
.. attribute:: nick